deblan.tv/vendor/trinity/src/Trinity/Bundle/NewsletterBundle/Model/om/BaseModel.php
2015-03-02 21:57:49 +01:00

2659 lines
91 KiB
PHP

<?php
namespace Trinity\Bundle\NewsletterBundle\Model\om;
use \BaseObject;
use \BasePeer;
use \Criteria;
use \DateTime;
use \Exception;
use \PDO;
use \Persistent;
use \Propel;
use \PropelCollection;
use \PropelDateTime;
use \PropelException;
use \PropelObjectCollection;
use \PropelPDO;
use Glorpen\Propel\PropelBundle\Dispatcher\EventDispatcherProxy;
use Glorpen\Propel\PropelBundle\Events\ModelEvent;
use Trinity\Bundle\NewsletterBundle\Model\Block;
use Trinity\Bundle\NewsletterBundle\Model\BlockQuery;
use Trinity\Bundle\NewsletterBundle\Model\BlockVersionPeer;
use Trinity\Bundle\NewsletterBundle\Model\BlockVersionQuery;
use Trinity\Bundle\NewsletterBundle\Model\Model;
use Trinity\Bundle\NewsletterBundle\Model\ModelPeer;
use Trinity\Bundle\NewsletterBundle\Model\ModelQuery;
use Trinity\Bundle\NewsletterBundle\Model\ModelVersion;
use Trinity\Bundle\NewsletterBundle\Model\ModelVersionPeer;
use Trinity\Bundle\NewsletterBundle\Model\ModelVersionQuery;
use Trinity\Bundle\NewsletterBundle\Model\Newsletter;
use Trinity\Bundle\NewsletterBundle\Model\NewsletterQuery;
abstract class BaseModel extends BaseObject implements Persistent
{
/**
* Peer class name
*/
const PEER = 'Trinity\\Bundle\\NewsletterBundle\\Model\\ModelPeer';
/**
* The Peer class.
* Instance provides a convenient way of calling static methods on a class
* that calling code may not be able to identify.
* @var ModelPeer
*/
protected static $peer;
/**
* The flag var to prevent infinite loop in deep copy
* @var boolean
*/
protected $startCopy = false;
/**
* The value for the id field.
* @var int
*/
protected $id;
/**
* The value for the name field.
* @var string
*/
protected $name;
/**
* The value for the template field.
* @var string
*/
protected $template;
/**
* The value for the class_key field.
* @var string
*/
protected $class_key;
/**
* The value for the created_at field.
* @var string
*/
protected $created_at;
/**
* The value for the updated_at field.
* @var string
*/
protected $updated_at;
/**
* The value for the version field.
* Note: this column has a database default value of: 0
* @var int
*/
protected $version;
/**
* The value for the version_created_at field.
* @var string
*/
protected $version_created_at;
/**
* The value for the version_created_by field.
* @var string
*/
protected $version_created_by;
/**
* @var PropelObjectCollection|Newsletter[] Collection to store aggregation of Newsletter objects.
*/
protected $collNewsletters;
protected $collNewslettersPartial;
/**
* @var PropelObjectCollection|Block[] Collection to store aggregation of Block objects.
*/
protected $collBlocks;
protected $collBlocksPartial;
/**
* @var PropelObjectCollection|ModelVersion[] Collection to store aggregation of ModelVersion objects.
*/
protected $collModelVersions;
protected $collModelVersionsPartial;
/**
* Flag to prevent endless save loop, if this object is referenced
* by another object which falls in this transaction.
* @var boolean
*/
protected $alreadyInSave = false;
/**
* Flag to prevent endless validation loop, if this object is referenced
* by another object which falls in this transaction.
* @var boolean
*/
protected $alreadyInValidation = false;
/**
* Flag to prevent endless clearAllReferences($deep=true) loop, if this object is referenced
* @var boolean
*/
protected $alreadyInClearAllReferencesDeep = false;
// versionable behavior
/**
* @var bool
*/
protected $enforceVersion = false;
/**
* An array of objects scheduled for deletion.
* @var PropelObjectCollection
*/
protected $newslettersScheduledForDeletion = null;
/**
* An array of objects scheduled for deletion.
* @var PropelObjectCollection
*/
protected $blocksScheduledForDeletion = null;
/**
* An array of objects scheduled for deletion.
* @var PropelObjectCollection
*/
protected $modelVersionsScheduledForDeletion = null;
/**
* Applies default values to this object.
* This method should be called from the object's constructor (or
* equivalent initialization method).
* @see __construct()
*/
public function applyDefaultValues()
{
$this->version = 0;
}
/**
* Initializes internal state of BaseModel object.
* @see applyDefaults()
*/
public function __construct()
{
parent::__construct();
$this->applyDefaultValues();
EventDispatcherProxy::trigger(array('construct','model.construct'), new ModelEvent($this));
}
/**
* Get the [id] column value.
*
* @return int
*/
public function getId()
{
return $this->id;
}
/**
* Get the [name] column value.
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Get the [template] column value.
*
* @return string
*/
public function getTemplate()
{
return $this->template;
}
/**
* Get the [class_key] column value.
*
* @return string
*/
public function getClassKey()
{
return $this->class_key;
}
/**
* Get the [optionally formatted] temporal [created_at] column value.
*
*
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is null, then the raw DateTime object will be returned.
* @return mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00
* @throws PropelException - if unable to parse/validate the date/time value.
*/
public function getCreatedAt($format = null)
{
if ($this->created_at === null) {
return null;
}
if ($this->created_at === '0000-00-00 00:00:00') {
// while technically this is not a default value of null,
// this seems to be closest in meaning.
return null;
}
try {
$dt = new DateTime($this->created_at);
} catch (Exception $x) {
throw new PropelException("Internally stored date/time/timestamp value could not be converted to DateTime: " . var_export($this->created_at, true), $x);
}
if ($format === null) {
// Because propel.useDateTimeClass is true, we return a DateTime object.
return $dt;
}
if (strpos($format, '%') !== false) {
return strftime($format, $dt->format('U'));
}
return $dt->format($format);
}
/**
* Get the [optionally formatted] temporal [updated_at] column value.
*
*
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is null, then the raw DateTime object will be returned.
* @return mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00
* @throws PropelException - if unable to parse/validate the date/time value.
*/
public function getUpdatedAt($format = null)
{
if ($this->updated_at === null) {
return null;
}
if ($this->updated_at === '0000-00-00 00:00:00') {
// while technically this is not a default value of null,
// this seems to be closest in meaning.
return null;
}
try {
$dt = new DateTime($this->updated_at);
} catch (Exception $x) {
throw new PropelException("Internally stored date/time/timestamp value could not be converted to DateTime: " . var_export($this->updated_at, true), $x);
}
if ($format === null) {
// Because propel.useDateTimeClass is true, we return a DateTime object.
return $dt;
}
if (strpos($format, '%') !== false) {
return strftime($format, $dt->format('U'));
}
return $dt->format($format);
}
/**
* Get the [version] column value.
*
* @return int
*/
public function getVersion()
{
return $this->version;
}
/**
* Get the [optionally formatted] temporal [version_created_at] column value.
*
*
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is null, then the raw DateTime object will be returned.
* @return mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00
* @throws PropelException - if unable to parse/validate the date/time value.
*/
public function getVersionCreatedAt($format = null)
{
if ($this->version_created_at === null) {
return null;
}
if ($this->version_created_at === '0000-00-00 00:00:00') {
// while technically this is not a default value of null,
// this seems to be closest in meaning.
return null;
}
try {
$dt = new DateTime($this->version_created_at);
} catch (Exception $x) {
throw new PropelException("Internally stored date/time/timestamp value could not be converted to DateTime: " . var_export($this->version_created_at, true), $x);
}
if ($format === null) {
// Because propel.useDateTimeClass is true, we return a DateTime object.
return $dt;
}
if (strpos($format, '%') !== false) {
return strftime($format, $dt->format('U'));
}
return $dt->format($format);
}
/**
* Get the [version_created_by] column value.
*
* @return string
*/
public function getVersionCreatedBy()
{
return $this->version_created_by;
}
/**
* Set the value of [id] column.
*
* @param int $v new value
* @return Model The current object (for fluent API support)
*/
public function setId($v)
{
if ($v !== null && is_numeric($v)) {
$v = (int) $v;
}
if ($this->id !== $v) {
$this->id = $v;
$this->modifiedColumns[] = ModelPeer::ID;
}
return $this;
} // setId()
/**
* Set the value of [name] column.
*
* @param string $v new value
* @return Model The current object (for fluent API support)
*/
public function setName($v)
{
if ($v !== null) {
$v = (string) $v;
}
if ($this->name !== $v) {
$this->name = $v;
$this->modifiedColumns[] = ModelPeer::NAME;
}
return $this;
} // setName()
/**
* Set the value of [template] column.
*
* @param string $v new value
* @return Model The current object (for fluent API support)
*/
public function setTemplate($v)
{
if ($v !== null) {
$v = (string) $v;
}
if ($this->template !== $v) {
$this->template = $v;
$this->modifiedColumns[] = ModelPeer::TEMPLATE;
}
return $this;
} // setTemplate()
/**
* Set the value of [class_key] column.
*
* @param string $v new value
* @return Model The current object (for fluent API support)
*/
public function setClassKey($v)
{
if ($v !== null) {
$v = (string) $v;
}
if ($this->class_key !== $v) {
$this->class_key = $v;
$this->modifiedColumns[] = ModelPeer::CLASS_KEY;
}
return $this;
} // setClassKey()
/**
* Sets the value of [created_at] column to a normalized version of the date/time value specified.
*
* @param mixed $v string, integer (timestamp), or DateTime value.
* Empty strings are treated as null.
* @return Model The current object (for fluent API support)
*/
public function setCreatedAt($v)
{
$dt = PropelDateTime::newInstance($v, null, 'DateTime');
if ($this->created_at !== null || $dt !== null) {
$currentDateAsString = ($this->created_at !== null && $tmpDt = new DateTime($this->created_at)) ? $tmpDt->format('Y-m-d H:i:s') : null;
$newDateAsString = $dt ? $dt->format('Y-m-d H:i:s') : null;
if ($currentDateAsString !== $newDateAsString) {
$this->created_at = $newDateAsString;
$this->modifiedColumns[] = ModelPeer::CREATED_AT;
}
} // if either are not null
return $this;
} // setCreatedAt()
/**
* Sets the value of [updated_at] column to a normalized version of the date/time value specified.
*
* @param mixed $v string, integer (timestamp), or DateTime value.
* Empty strings are treated as null.
* @return Model The current object (for fluent API support)
*/
public function setUpdatedAt($v)
{
$dt = PropelDateTime::newInstance($v, null, 'DateTime');
if ($this->updated_at !== null || $dt !== null) {
$currentDateAsString = ($this->updated_at !== null && $tmpDt = new DateTime($this->updated_at)) ? $tmpDt->format('Y-m-d H:i:s') : null;
$newDateAsString = $dt ? $dt->format('Y-m-d H:i:s') : null;
if ($currentDateAsString !== $newDateAsString) {
$this->updated_at = $newDateAsString;
$this->modifiedColumns[] = ModelPeer::UPDATED_AT;
}
} // if either are not null
return $this;
} // setUpdatedAt()
/**
* Set the value of [version] column.
*
* @param int $v new value
* @return Model The current object (for fluent API support)
*/
public function setVersion($v)
{
if ($v !== null && is_numeric($v)) {
$v = (int) $v;
}
if ($this->version !== $v) {
$this->version = $v;
$this->modifiedColumns[] = ModelPeer::VERSION;
}
return $this;
} // setVersion()
/**
* Sets the value of [version_created_at] column to a normalized version of the date/time value specified.
*
* @param mixed $v string, integer (timestamp), or DateTime value.
* Empty strings are treated as null.
* @return Model The current object (for fluent API support)
*/
public function setVersionCreatedAt($v)
{
$dt = PropelDateTime::newInstance($v, null, 'DateTime');
if ($this->version_created_at !== null || $dt !== null) {
$currentDateAsString = ($this->version_created_at !== null && $tmpDt = new DateTime($this->version_created_at)) ? $tmpDt->format('Y-m-d H:i:s') : null;
$newDateAsString = $dt ? $dt->format('Y-m-d H:i:s') : null;
if ($currentDateAsString !== $newDateAsString) {
$this->version_created_at = $newDateAsString;
$this->modifiedColumns[] = ModelPeer::VERSION_CREATED_AT;
}
} // if either are not null
return $this;
} // setVersionCreatedAt()
/**
* Set the value of [version_created_by] column.
*
* @param string $v new value
* @return Model The current object (for fluent API support)
*/
public function setVersionCreatedBy($v)
{
if ($v !== null) {
$v = (string) $v;
}
if ($this->version_created_by !== $v) {
$this->version_created_by = $v;
$this->modifiedColumns[] = ModelPeer::VERSION_CREATED_BY;
}
return $this;
} // setVersionCreatedBy()
/**
* Indicates whether the columns in this object are only set to default values.
*
* This method can be used in conjunction with isModified() to indicate whether an object is both
* modified _and_ has some values set which are non-default.
*
* @return boolean Whether the columns in this object are only been set with default values.
*/
public function hasOnlyDefaultValues()
{
if ($this->version !== 0) {
return false;
}
// otherwise, everything was equal, so return true
return true;
} // hasOnlyDefaultValues()
/**
* Hydrates (populates) the object variables with values from the database resultset.
*
* An offset (0-based "start column") is specified so that objects can be hydrated
* with a subset of the columns in the resultset rows. This is needed, for example,
* for results of JOIN queries where the resultset row includes columns from two or
* more tables.
*
* @param array $row The row returned by PDOStatement->fetch(PDO::FETCH_NUM)
* @param int $startcol 0-based offset column which indicates which resultset column to start with.
* @param boolean $rehydrate Whether this object is being re-hydrated from the database.
* @return int next starting column
* @throws PropelException - Any caught Exception will be rewrapped as a PropelException.
*/
public function hydrate($row, $startcol = 0, $rehydrate = false)
{
try {
$this->id = ($row[$startcol + 0] !== null) ? (int) $row[$startcol + 0] : null;
$this->name = ($row[$startcol + 1] !== null) ? (string) $row[$startcol + 1] : null;
$this->template = ($row[$startcol + 2] !== null) ? (string) $row[$startcol + 2] : null;
$this->class_key = ($row[$startcol + 3] !== null) ? (string) $row[$startcol + 3] : null;
$this->created_at = ($row[$startcol + 4] !== null) ? (string) $row[$startcol + 4] : null;
$this->updated_at = ($row[$startcol + 5] !== null) ? (string) $row[$startcol + 5] : null;
$this->version = ($row[$startcol + 6] !== null) ? (int) $row[$startcol + 6] : null;
$this->version_created_at = ($row[$startcol + 7] !== null) ? (string) $row[$startcol + 7] : null;
$this->version_created_by = ($row[$startcol + 8] !== null) ? (string) $row[$startcol + 8] : null;
$this->resetModified();
$this->setNew(false);
if ($rehydrate) {
$this->ensureConsistency();
}
$this->postHydrate($row, $startcol, $rehydrate);
return $startcol + 9; // 9 = ModelPeer::NUM_HYDRATE_COLUMNS.
} catch (Exception $e) {
throw new PropelException("Error populating Model object", $e);
}
}
/**
* Checks and repairs the internal consistency of the object.
*
* This method is executed after an already-instantiated object is re-hydrated
* from the database. It exists to check any foreign keys to make sure that
* the objects related to the current object are correct based on foreign key.
*
* You can override this method in the stub class, but you should always invoke
* the base method from the overridden method (i.e. parent::ensureConsistency()),
* in case your model changes.
*
* @throws PropelException
*/
public function ensureConsistency()
{
} // ensureConsistency
/**
* Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
*
* This will only work if the object has been saved and has a valid primary key set.
*
* @param boolean $deep (optional) Whether to also de-associated any related objects.
* @param PropelPDO $con (optional) The PropelPDO connection to use.
* @return void
* @throws PropelException - if this object is deleted, unsaved or doesn't have pk match in db
*/
public function reload($deep = false, PropelPDO $con = null)
{
if ($this->isDeleted()) {
throw new PropelException("Cannot reload a deleted object.");
}
if ($this->isNew()) {
throw new PropelException("Cannot reload an unsaved object.");
}
if ($con === null) {
$con = Propel::getConnection(ModelPeer::DATABASE_NAME, Propel::CONNECTION_READ);
}
// We don't need to alter the object instance pool; we're just modifying this instance
// already in the pool.
$stmt = ModelPeer::doSelectStmt($this->buildPkeyCriteria(), $con);
$row = $stmt->fetch(PDO::FETCH_NUM);
$stmt->closeCursor();
if (!$row) {
throw new PropelException('Cannot find matching row in the database to reload object values.');
}
$this->hydrate($row, 0, true); // rehydrate
if ($deep) { // also de-associate any related objects?
$this->collNewsletters = null;
$this->collBlocks = null;
$this->collModelVersions = null;
} // if (deep)
}
/**
* Removes this object from datastore and sets delete attribute.
*
* @param PropelPDO $con
* @return void
* @throws PropelException
* @throws Exception
* @see BaseObject::setDeleted()
* @see BaseObject::isDeleted()
*/
public function delete(PropelPDO $con = null)
{
if ($this->isDeleted()) {
throw new PropelException("This object has already been deleted.");
}
if ($con === null) {
$con = Propel::getConnection(ModelPeer::DATABASE_NAME, Propel::CONNECTION_WRITE);
}
$con->beginTransaction();
try {
$deleteQuery = ModelQuery::create()
->filterByPrimaryKey($this->getPrimaryKey());
$ret = $this->preDelete($con);
// event behavior
EventDispatcherProxy::trigger(array('delete.pre','model.delete.pre'), new ModelEvent($this));
if ($ret) {
$deleteQuery->delete($con);
$this->postDelete($con);
// versionable behavior
// emulate delete cascade
ModelVersionQuery::create()
->filterByModel($this)
->delete($con);
// event behavior
EventDispatcherProxy::trigger(array('delete.post', 'model.delete.post'), new ModelEvent($this));
$con->commit();
$this->setDeleted(true);
} else {
$con->commit();
}
} catch (Exception $e) {
$con->rollBack();
throw $e;
}
}
/**
* Persists this object to the database.
*
* If the object is new, it inserts it; otherwise an update is performed.
* All modified related objects will also be persisted in the doSave()
* method. This method wraps all precipitate database operations in a
* single transaction.
*
* @param PropelPDO $con
* @return int The number of rows affected by this insert/update and any referring fk objects' save() operations.
* @throws PropelException
* @throws Exception
* @see doSave()
*/
public function save(PropelPDO $con = null)
{
if ($this->isDeleted()) {
throw new PropelException("You cannot save an object that has been deleted.");
}
if ($con === null) {
$con = Propel::getConnection(ModelPeer::DATABASE_NAME, Propel::CONNECTION_WRITE);
}
$con->beginTransaction();
$isInsert = $this->isNew();
try {
$ret = $this->preSave($con);
// versionable behavior
if ($this->isVersioningNecessary()) {
$this->setVersion($this->isNew() ? 1 : $this->getLastVersionNumber($con) + 1);
if (!$this->isColumnModified(ModelPeer::VERSION_CREATED_AT)) {
$this->setVersionCreatedAt(time());
}
$createVersion = true; // for postSave hook
}
// event behavior
EventDispatcherProxy::trigger('model.save.pre', new ModelEvent($this));
if ($isInsert) {
$ret = $ret && $this->preInsert($con);
// timestampable behavior
if (!$this->isColumnModified(ModelPeer::CREATED_AT)) {
$this->setCreatedAt(time());
}
if (!$this->isColumnModified(ModelPeer::UPDATED_AT)) {
$this->setUpdatedAt(time());
}
// event behavior
EventDispatcherProxy::trigger('model.insert.pre', new ModelEvent($this));
} else {
$ret = $ret && $this->preUpdate($con);
// timestampable behavior
if ($this->isModified() && !$this->isColumnModified(ModelPeer::UPDATED_AT)) {
$this->setUpdatedAt(time());
}
// event behavior
EventDispatcherProxy::trigger(array('update.pre', 'model.update.pre'), new ModelEvent($this));
}
if ($ret) {
$affectedRows = $this->doSave($con);
if ($isInsert) {
$this->postInsert($con);
// event behavior
EventDispatcherProxy::trigger('model.insert.post', new ModelEvent($this));
} else {
$this->postUpdate($con);
// event behavior
EventDispatcherProxy::trigger(array('update.post', 'model.update.post'), new ModelEvent($this));
}
$this->postSave($con);
// versionable behavior
if (isset($createVersion)) {
$this->addVersion($con);
}
// event behavior
EventDispatcherProxy::trigger('model.save.post', new ModelEvent($this));
ModelPeer::addInstanceToPool($this);
} else {
$affectedRows = 0;
}
$con->commit();
return $affectedRows;
} catch (Exception $e) {
$con->rollBack();
throw $e;
}
}
/**
* Performs the work of inserting or updating the row in the database.
*
* If the object is new, it inserts it; otherwise an update is performed.
* All related objects are also updated in this method.
*
* @param PropelPDO $con
* @return int The number of rows affected by this insert/update and any referring fk objects' save() operations.
* @throws PropelException
* @see save()
*/
protected function doSave(PropelPDO $con)
{
$affectedRows = 0; // initialize var to track total num of affected rows
if (!$this->alreadyInSave) {
$this->alreadyInSave = true;
if ($this->isNew() || $this->isModified()) {
// persist changes
if ($this->isNew()) {
$this->doInsert($con);
} else {
$this->doUpdate($con);
}
$affectedRows += 1;
$this->resetModified();
}
if ($this->newslettersScheduledForDeletion !== null) {
if (!$this->newslettersScheduledForDeletion->isEmpty()) {
foreach ($this->newslettersScheduledForDeletion as $newsletter) {
// need to save related object because we set the relation to null
$newsletter->save($con);
}
$this->newslettersScheduledForDeletion = null;
}
}
if ($this->collNewsletters !== null) {
foreach ($this->collNewsletters as $referrerFK) {
if (!$referrerFK->isDeleted() && ($referrerFK->isNew() || $referrerFK->isModified())) {
$affectedRows += $referrerFK->save($con);
}
}
}
if ($this->blocksScheduledForDeletion !== null) {
if (!$this->blocksScheduledForDeletion->isEmpty()) {
BlockQuery::create()
->filterByPrimaryKeys($this->blocksScheduledForDeletion->getPrimaryKeys(false))
->delete($con);
$this->blocksScheduledForDeletion = null;
}
}
if ($this->collBlocks !== null) {
foreach ($this->collBlocks as $referrerFK) {
if (!$referrerFK->isDeleted() && ($referrerFK->isNew() || $referrerFK->isModified())) {
$affectedRows += $referrerFK->save($con);
}
}
}
if ($this->modelVersionsScheduledForDeletion !== null) {
if (!$this->modelVersionsScheduledForDeletion->isEmpty()) {
ModelVersionQuery::create()
->filterByPrimaryKeys($this->modelVersionsScheduledForDeletion->getPrimaryKeys(false))
->delete($con);
$this->modelVersionsScheduledForDeletion = null;
}
}
if ($this->collModelVersions !== null) {
foreach ($this->collModelVersions as $referrerFK) {
if (!$referrerFK->isDeleted() && ($referrerFK->isNew() || $referrerFK->isModified())) {
$affectedRows += $referrerFK->save($con);
}
}
}
$this->alreadyInSave = false;
}
return $affectedRows;
} // doSave()
/**
* Insert the row in the database.
*
* @param PropelPDO $con
*
* @throws PropelException
* @see doSave()
*/
protected function doInsert(PropelPDO $con)
{
$modifiedColumns = array();
$index = 0;
$this->modifiedColumns[] = ModelPeer::ID;
if (null !== $this->id) {
throw new PropelException('Cannot insert a value for auto-increment primary key (' . ModelPeer::ID . ')');
}
// check the columns in natural order for more readable SQL queries
if ($this->isColumnModified(ModelPeer::ID)) {
$modifiedColumns[':p' . $index++] = '`id`';
}
if ($this->isColumnModified(ModelPeer::NAME)) {
$modifiedColumns[':p' . $index++] = '`name`';
}
if ($this->isColumnModified(ModelPeer::TEMPLATE)) {
$modifiedColumns[':p' . $index++] = '`template`';
}
if ($this->isColumnModified(ModelPeer::CLASS_KEY)) {
$modifiedColumns[':p' . $index++] = '`class_key`';
}
if ($this->isColumnModified(ModelPeer::CREATED_AT)) {
$modifiedColumns[':p' . $index++] = '`created_at`';
}
if ($this->isColumnModified(ModelPeer::UPDATED_AT)) {
$modifiedColumns[':p' . $index++] = '`updated_at`';
}
if ($this->isColumnModified(ModelPeer::VERSION)) {
$modifiedColumns[':p' . $index++] = '`version`';
}
if ($this->isColumnModified(ModelPeer::VERSION_CREATED_AT)) {
$modifiedColumns[':p' . $index++] = '`version_created_at`';
}
if ($this->isColumnModified(ModelPeer::VERSION_CREATED_BY)) {
$modifiedColumns[':p' . $index++] = '`version_created_by`';
}
$sql = sprintf(
'INSERT INTO `nws_model` (%s) VALUES (%s)',
implode(', ', $modifiedColumns),
implode(', ', array_keys($modifiedColumns))
);
try {
$stmt = $con->prepare($sql);
foreach ($modifiedColumns as $identifier => $columnName) {
switch ($columnName) {
case '`id`':
$stmt->bindValue($identifier, $this->id, PDO::PARAM_INT);
break;
case '`name`':
$stmt->bindValue($identifier, $this->name, PDO::PARAM_STR);
break;
case '`template`':
$stmt->bindValue($identifier, $this->template, PDO::PARAM_STR);
break;
case '`class_key`':
$stmt->bindValue($identifier, $this->class_key, PDO::PARAM_STR);
break;
case '`created_at`':
$stmt->bindValue($identifier, $this->created_at, PDO::PARAM_STR);
break;
case '`updated_at`':
$stmt->bindValue($identifier, $this->updated_at, PDO::PARAM_STR);
break;
case '`version`':
$stmt->bindValue($identifier, $this->version, PDO::PARAM_INT);
break;
case '`version_created_at`':
$stmt->bindValue($identifier, $this->version_created_at, PDO::PARAM_STR);
break;
case '`version_created_by`':
$stmt->bindValue($identifier, $this->version_created_by, PDO::PARAM_STR);
break;
}
}
$stmt->execute();
} catch (Exception $e) {
Propel::log($e->getMessage(), Propel::LOG_ERR);
throw new PropelException(sprintf('Unable to execute INSERT statement [%s]', $sql), $e);
}
try {
$pk = $con->lastInsertId();
} catch (Exception $e) {
throw new PropelException('Unable to get autoincrement id.', $e);
}
$this->setId($pk);
$this->setNew(false);
}
/**
* Update the row in the database.
*
* @param PropelPDO $con
*
* @see doSave()
*/
protected function doUpdate(PropelPDO $con)
{
$selectCriteria = $this->buildPkeyCriteria();
$valuesCriteria = $this->buildCriteria();
BasePeer::doUpdate($selectCriteria, $valuesCriteria, $con);
}
/**
* Array of ValidationFailed objects.
* @var array ValidationFailed[]
*/
protected $validationFailures = array();
/**
* Gets any ValidationFailed objects that resulted from last call to validate().
*
*
* @return array ValidationFailed[]
* @see validate()
*/
public function getValidationFailures()
{
return $this->validationFailures;
}
/**
* Validates the objects modified field values and all objects related to this table.
*
* If $columns is either a column name or an array of column names
* only those columns are validated.
*
* @param mixed $columns Column name or an array of column names.
* @return boolean Whether all columns pass validation.
* @see doValidate()
* @see getValidationFailures()
*/
public function validate($columns = null)
{
$res = $this->doValidate($columns);
if ($res === true) {
$this->validationFailures = array();
return true;
}
$this->validationFailures = $res;
return false;
}
/**
* This function performs the validation work for complex object models.
*
* In addition to checking the current object, all related objects will
* also be validated. If all pass then <code>true</code> is returned; otherwise
* an aggregated array of ValidationFailed objects will be returned.
*
* @param array $columns Array of column names to validate.
* @return mixed <code>true</code> if all validations pass; array of <code>ValidationFailed</code> objects otherwise.
*/
protected function doValidate($columns = null)
{
if (!$this->alreadyInValidation) {
$this->alreadyInValidation = true;
$retval = null;
$failureMap = array();
if (($retval = ModelPeer::doValidate($this, $columns)) !== true) {
$failureMap = array_merge($failureMap, $retval);
}
if ($this->collNewsletters !== null) {
foreach ($this->collNewsletters as $referrerFK) {
if (!$referrerFK->validate($columns)) {
$failureMap = array_merge($failureMap, $referrerFK->getValidationFailures());
}
}
}
if ($this->collBlocks !== null) {
foreach ($this->collBlocks as $referrerFK) {
if (!$referrerFK->validate($columns)) {
$failureMap = array_merge($failureMap, $referrerFK->getValidationFailures());
}
}
}
if ($this->collModelVersions !== null) {
foreach ($this->collModelVersions as $referrerFK) {
if (!$referrerFK->validate($columns)) {
$failureMap = array_merge($failureMap, $referrerFK->getValidationFailures());
}
}
}
$this->alreadyInValidation = false;
}
return (!empty($failureMap) ? $failureMap : true);
}
/**
* Retrieves a field from the object by name passed in as a string.
*
* @param string $name name
* @param string $type The type of fieldname the $name is of:
* one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* Defaults to BasePeer::TYPE_PHPNAME
* @return mixed Value of field.
*/
public function getByName($name, $type = BasePeer::TYPE_PHPNAME)
{
$pos = ModelPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
$field = $this->getByPosition($pos);
return $field;
}
/**
* Retrieves a field from the object by Position as specified in the xml schema.
* Zero-based.
*
* @param int $pos position in xml schema
* @return mixed Value of field at $pos
*/
public function getByPosition($pos)
{
switch ($pos) {
case 0:
return $this->getId();
break;
case 1:
return $this->getName();
break;
case 2:
return $this->getTemplate();
break;
case 3:
return $this->getClassKey();
break;
case 4:
return $this->getCreatedAt();
break;
case 5:
return $this->getUpdatedAt();
break;
case 6:
return $this->getVersion();
break;
case 7:
return $this->getVersionCreatedAt();
break;
case 8:
return $this->getVersionCreatedBy();
break;
default:
return null;
break;
} // switch()
}
/**
* Exports the object as an array.
*
* You can specify the key type of the array by passing one of the class
* type constants.
*
* @param string $keyType (optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME,
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* Defaults to BasePeer::TYPE_PHPNAME.
* @param boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to true.
* @param array $alreadyDumpedObjects List of objects to skip to avoid recursion
* @param boolean $includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE.
*
* @return array an associative array containing the field names (as keys) and field values
*/
public function toArray($keyType = BasePeer::TYPE_PHPNAME, $includeLazyLoadColumns = true, $alreadyDumpedObjects = array(), $includeForeignObjects = false)
{
if (isset($alreadyDumpedObjects['Model'][$this->getPrimaryKey()])) {
return '*RECURSION*';
}
$alreadyDumpedObjects['Model'][$this->getPrimaryKey()] = true;
$keys = ModelPeer::getFieldNames($keyType);
$result = array(
$keys[0] => $this->getId(),
$keys[1] => $this->getName(),
$keys[2] => $this->getTemplate(),
$keys[3] => $this->getClassKey(),
$keys[4] => $this->getCreatedAt(),
$keys[5] => $this->getUpdatedAt(),
$keys[6] => $this->getVersion(),
$keys[7] => $this->getVersionCreatedAt(),
$keys[8] => $this->getVersionCreatedBy(),
);
$virtualColumns = $this->virtualColumns;
foreach ($virtualColumns as $key => $virtualColumn) {
$result[$key] = $virtualColumn;
}
if ($includeForeignObjects) {
if (null !== $this->collNewsletters) {
$result['Newsletters'] = $this->collNewsletters->toArray(null, true, $keyType, $includeLazyLoadColumns, $alreadyDumpedObjects);
}
if (null !== $this->collBlocks) {
$result['Blocks'] = $this->collBlocks->toArray(null, true, $keyType, $includeLazyLoadColumns, $alreadyDumpedObjects);
}
if (null !== $this->collModelVersions) {
$result['ModelVersions'] = $this->collModelVersions->toArray(null, true, $keyType, $includeLazyLoadColumns, $alreadyDumpedObjects);
}
}
return $result;
}
/**
* Sets a field from the object by name passed in as a string.
*
* @param string $name peer name
* @param mixed $value field value
* @param string $type The type of fieldname the $name is of:
* one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* Defaults to BasePeer::TYPE_PHPNAME
* @return void
*/
public function setByName($name, $value, $type = BasePeer::TYPE_PHPNAME)
{
$pos = ModelPeer::translateFieldName($name, $type, BasePeer::TYPE_NUM);
$this->setByPosition($pos, $value);
}
/**
* Sets a field from the object by Position as specified in the xml schema.
* Zero-based.
*
* @param int $pos position in xml schema
* @param mixed $value field value
* @return void
*/
public function setByPosition($pos, $value)
{
switch ($pos) {
case 0:
$this->setId($value);
break;
case 1:
$this->setName($value);
break;
case 2:
$this->setTemplate($value);
break;
case 3:
$this->setClassKey($value);
break;
case 4:
$this->setCreatedAt($value);
break;
case 5:
$this->setUpdatedAt($value);
break;
case 6:
$this->setVersion($value);
break;
case 7:
$this->setVersionCreatedAt($value);
break;
case 8:
$this->setVersionCreatedBy($value);
break;
} // switch()
}
/**
* Populates the object using an array.
*
* This is particularly useful when populating an object from one of the
* request arrays (e.g. $_POST). This method goes through the column
* names, checking to see whether a matching key exists in populated
* array. If so the setByName() method is called for that column.
*
* You can specify the key type of the array by additionally passing one
* of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME,
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* The default key type is the column's BasePeer::TYPE_PHPNAME
*
* @param array $arr An array to populate the object from.
* @param string $keyType The type of keys the array uses.
* @return void
*/
public function fromArray($arr, $keyType = BasePeer::TYPE_PHPNAME)
{
$keys = ModelPeer::getFieldNames($keyType);
if (array_key_exists($keys[0], $arr)) $this->setId($arr[$keys[0]]);
if (array_key_exists($keys[1], $arr)) $this->setName($arr[$keys[1]]);
if (array_key_exists($keys[2], $arr)) $this->setTemplate($arr[$keys[2]]);
if (array_key_exists($keys[3], $arr)) $this->setClassKey($arr[$keys[3]]);
if (array_key_exists($keys[4], $arr)) $this->setCreatedAt($arr[$keys[4]]);
if (array_key_exists($keys[5], $arr)) $this->setUpdatedAt($arr[$keys[5]]);
if (array_key_exists($keys[6], $arr)) $this->setVersion($arr[$keys[6]]);
if (array_key_exists($keys[7], $arr)) $this->setVersionCreatedAt($arr[$keys[7]]);
if (array_key_exists($keys[8], $arr)) $this->setVersionCreatedBy($arr[$keys[8]]);
}
/**
* Build a Criteria object containing the values of all modified columns in this object.
*
* @return Criteria The Criteria object containing all modified values.
*/
public function buildCriteria()
{
$criteria = new Criteria(ModelPeer::DATABASE_NAME);
if ($this->isColumnModified(ModelPeer::ID)) $criteria->add(ModelPeer::ID, $this->id);
if ($this->isColumnModified(ModelPeer::NAME)) $criteria->add(ModelPeer::NAME, $this->name);
if ($this->isColumnModified(ModelPeer::TEMPLATE)) $criteria->add(ModelPeer::TEMPLATE, $this->template);
if ($this->isColumnModified(ModelPeer::CLASS_KEY)) $criteria->add(ModelPeer::CLASS_KEY, $this->class_key);
if ($this->isColumnModified(ModelPeer::CREATED_AT)) $criteria->add(ModelPeer::CREATED_AT, $this->created_at);
if ($this->isColumnModified(ModelPeer::UPDATED_AT)) $criteria->add(ModelPeer::UPDATED_AT, $this->updated_at);
if ($this->isColumnModified(ModelPeer::VERSION)) $criteria->add(ModelPeer::VERSION, $this->version);
if ($this->isColumnModified(ModelPeer::VERSION_CREATED_AT)) $criteria->add(ModelPeer::VERSION_CREATED_AT, $this->version_created_at);
if ($this->isColumnModified(ModelPeer::VERSION_CREATED_BY)) $criteria->add(ModelPeer::VERSION_CREATED_BY, $this->version_created_by);
return $criteria;
}
/**
* Builds a Criteria object containing the primary key for this object.
*
* Unlike buildCriteria() this method includes the primary key values regardless
* of whether or not they have been modified.
*
* @return Criteria The Criteria object containing value(s) for primary key(s).
*/
public function buildPkeyCriteria()
{
$criteria = new Criteria(ModelPeer::DATABASE_NAME);
$criteria->add(ModelPeer::ID, $this->id);
return $criteria;
}
/**
* Returns the primary key for this object (row).
* @return int
*/
public function getPrimaryKey()
{
return $this->getId();
}
/**
* Generic method to set the primary key (id column).
*
* @param int $key Primary key.
* @return void
*/
public function setPrimaryKey($key)
{
$this->setId($key);
}
/**
* Returns true if the primary key for this object is null.
* @return boolean
*/
public function isPrimaryKeyNull()
{
return null === $this->getId();
}
/**
* Sets contents of passed object to values from current object.
*
* If desired, this method can also make copies of all associated (fkey referrers)
* objects.
*
* @param object $copyObj An object of Model (or compatible) type.
* @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
* @param boolean $makeNew Whether to reset autoincrement PKs and make the object new.
* @throws PropelException
*/
public function copyInto($copyObj, $deepCopy = false, $makeNew = true)
{
$copyObj->setName($this->getName());
$copyObj->setTemplate($this->getTemplate());
$copyObj->setClassKey($this->getClassKey());
$copyObj->setCreatedAt($this->getCreatedAt());
$copyObj->setUpdatedAt($this->getUpdatedAt());
$copyObj->setVersion($this->getVersion());
$copyObj->setVersionCreatedAt($this->getVersionCreatedAt());
$copyObj->setVersionCreatedBy($this->getVersionCreatedBy());
if ($deepCopy && !$this->startCopy) {
// important: temporarily setNew(false) because this affects the behavior of
// the getter/setter methods for fkey referrer objects.
$copyObj->setNew(false);
// store object hash to prevent cycle
$this->startCopy = true;
foreach ($this->getNewsletters() as $relObj) {
if ($relObj !== $this) { // ensure that we don't try to copy a reference to ourselves
$copyObj->addNewsletter($relObj->copy($deepCopy));
}
}
foreach ($this->getBlocks() as $relObj) {
if ($relObj !== $this) { // ensure that we don't try to copy a reference to ourselves
$copyObj->addBlock($relObj->copy($deepCopy));
}
}
foreach ($this->getModelVersions() as $relObj) {
if ($relObj !== $this) { // ensure that we don't try to copy a reference to ourselves
$copyObj->addModelVersion($relObj->copy($deepCopy));
}
}
//unflag object copy
$this->startCopy = false;
} // if ($deepCopy)
if ($makeNew) {
$copyObj->setNew(true);
$copyObj->setId(NULL); // this is a auto-increment column, so set to default value
}
}
/**
* Makes a copy of this object that will be inserted as a new row in table when saved.
* It creates a new object filling in the simple attributes, but skipping any primary
* keys that are defined for the table.
*
* If desired, this method can also make copies of all associated (fkey referrers)
* objects.
*
* @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
* @return Model Clone of current object.
* @throws PropelException
*/
public function copy($deepCopy = false)
{
// we use get_class(), because this might be a subclass
$clazz = get_class($this);
$copyObj = new $clazz();
$this->copyInto($copyObj, $deepCopy);
return $copyObj;
}
/**
* Returns a peer instance associated with this om.
*
* Since Peer classes are not to have any instance attributes, this method returns the
* same instance for all member of this class. The method could therefore
* be static, but this would prevent one from overriding the behavior.
*
* @return ModelPeer
*/
public function getPeer()
{
if (self::$peer === null) {
self::$peer = new ModelPeer();
}
return self::$peer;
}
/**
* Initializes a collection based on the name of a relation.
* Avoids crafting an 'init[$relationName]s' method name
* that wouldn't work when StandardEnglishPluralizer is used.
*
* @param string $relationName The name of the relation to initialize
* @return void
*/
public function initRelation($relationName)
{
if ('Newsletter' == $relationName) {
$this->initNewsletters();
}
if ('Block' == $relationName) {
$this->initBlocks();
}
if ('ModelVersion' == $relationName) {
$this->initModelVersions();
}
}
/**
* Clears out the collNewsletters collection
*
* This does not modify the database; however, it will remove any associated objects, causing
* them to be refetched by subsequent calls to accessor method.
*
* @return Model The current object (for fluent API support)
* @see addNewsletters()
*/
public function clearNewsletters()
{
$this->collNewsletters = null; // important to set this to null since that means it is uninitialized
$this->collNewslettersPartial = null;
return $this;
}
/**
* reset is the collNewsletters collection loaded partially
*
* @return void
*/
public function resetPartialNewsletters($v = true)
{
$this->collNewslettersPartial = $v;
}
/**
* Initializes the collNewsletters collection.
*
* By default this just sets the collNewsletters collection to an empty array (like clearcollNewsletters());
* however, you may wish to override this method in your stub class to provide setting appropriate
* to your application -- for example, setting the initial array to the values stored in database.
*
* @param boolean $overrideExisting If set to true, the method call initializes
* the collection even if it is not empty
*
* @return void
*/
public function initNewsletters($overrideExisting = true)
{
if (null !== $this->collNewsletters && !$overrideExisting) {
return;
}
$this->collNewsletters = new PropelObjectCollection();
$this->collNewsletters->setModel('Newsletter');
}
/**
* Gets an array of Newsletter objects which contain a foreign key that references this object.
*
* If the $criteria is not null, it is used to always fetch the results from the database.
* Otherwise the results are fetched from the database the first time, then cached.
* Next time the same method is called without $criteria, the cached collection is returned.
* If this Model is new, it will return
* an empty collection or the current collection; the criteria is ignored on a new object.
*
* @param Criteria $criteria optional Criteria object to narrow the query
* @param PropelPDO $con optional connection object
* @return PropelObjectCollection|Newsletter[] List of Newsletter objects
* @throws PropelException
*/
public function getNewsletters($criteria = null, PropelPDO $con = null)
{
$partial = $this->collNewslettersPartial && !$this->isNew();
if (null === $this->collNewsletters || null !== $criteria || $partial) {
if ($this->isNew() && null === $this->collNewsletters) {
// return empty collection
$this->initNewsletters();
} else {
$collNewsletters = NewsletterQuery::create(null, $criteria)
->filterByModel($this)
->find($con);
if (null !== $criteria) {
if (false !== $this->collNewslettersPartial && count($collNewsletters)) {
$this->initNewsletters(false);
foreach ($collNewsletters as $obj) {
if (false == $this->collNewsletters->contains($obj)) {
$this->collNewsletters->append($obj);
}
}
$this->collNewslettersPartial = true;
}
$collNewsletters->getInternalIterator()->rewind();
return $collNewsletters;
}
if ($partial && $this->collNewsletters) {
foreach ($this->collNewsletters as $obj) {
if ($obj->isNew()) {
$collNewsletters[] = $obj;
}
}
}
$this->collNewsletters = $collNewsletters;
$this->collNewslettersPartial = false;
}
}
return $this->collNewsletters;
}
/**
* Sets a collection of Newsletter objects related by a one-to-many relationship
* to the current object.
* It will also schedule objects for deletion based on a diff between old objects (aka persisted)
* and new objects from the given Propel collection.
*
* @param PropelCollection $newsletters A Propel collection.
* @param PropelPDO $con Optional connection object
* @return Model The current object (for fluent API support)
*/
public function setNewsletters(PropelCollection $newsletters, PropelPDO $con = null)
{
$newslettersToDelete = $this->getNewsletters(new Criteria(), $con)->diff($newsletters);
$this->newslettersScheduledForDeletion = $newslettersToDelete;
foreach ($newslettersToDelete as $newsletterRemoved) {
$newsletterRemoved->setModel(null);
}
$this->collNewsletters = null;
foreach ($newsletters as $newsletter) {
$this->addNewsletter($newsletter);
}
$this->collNewsletters = $newsletters;
$this->collNewslettersPartial = false;
return $this;
}
/**
* Returns the number of related Newsletter objects.
*
* @param Criteria $criteria
* @param boolean $distinct
* @param PropelPDO $con
* @return int Count of related Newsletter objects.
* @throws PropelException
*/
public function countNewsletters(Criteria $criteria = null, $distinct = false, PropelPDO $con = null)
{
$partial = $this->collNewslettersPartial && !$this->isNew();
if (null === $this->collNewsletters || null !== $criteria || $partial) {
if ($this->isNew() && null === $this->collNewsletters) {
return 0;
}
if ($partial && !$criteria) {
return count($this->getNewsletters());
}
$query = NewsletterQuery::create(null, $criteria);
if ($distinct) {
$query->distinct();
}
return $query
->filterByModel($this)
->count($con);
}
return count($this->collNewsletters);
}
/**
* Method called to associate a Newsletter object to this object
* through the Newsletter foreign key attribute.
*
* @param Newsletter $l Newsletter
* @return Model The current object (for fluent API support)
*/
public function addNewsletter(Newsletter $l)
{
if ($this->collNewsletters === null) {
$this->initNewsletters();
$this->collNewslettersPartial = true;
}
if (!in_array($l, $this->collNewsletters->getArrayCopy(), true)) { // only add it if the **same** object is not already associated
$this->doAddNewsletter($l);
if ($this->newslettersScheduledForDeletion and $this->newslettersScheduledForDeletion->contains($l)) {
$this->newslettersScheduledForDeletion->remove($this->newslettersScheduledForDeletion->search($l));
}
}
return $this;
}
/**
* @param Newsletter $newsletter The newsletter object to add.
*/
protected function doAddNewsletter($newsletter)
{
$this->collNewsletters[]= $newsletter;
$newsletter->setModel($this);
}
/**
* @param Newsletter $newsletter The newsletter object to remove.
* @return Model The current object (for fluent API support)
*/
public function removeNewsletter($newsletter)
{
if ($this->getNewsletters()->contains($newsletter)) {
$this->collNewsletters->remove($this->collNewsletters->search($newsletter));
if (null === $this->newslettersScheduledForDeletion) {
$this->newslettersScheduledForDeletion = clone $this->collNewsletters;
$this->newslettersScheduledForDeletion->clear();
}
$this->newslettersScheduledForDeletion[]= $newsletter;
$newsletter->setModel(null);
}
return $this;
}
/**
* Clears out the collBlocks collection
*
* This does not modify the database; however, it will remove any associated objects, causing
* them to be refetched by subsequent calls to accessor method.
*
* @return Model The current object (for fluent API support)
* @see addBlocks()
*/
public function clearBlocks()
{
$this->collBlocks = null; // important to set this to null since that means it is uninitialized
$this->collBlocksPartial = null;
return $this;
}
/**
* reset is the collBlocks collection loaded partially
*
* @return void
*/
public function resetPartialBlocks($v = true)
{
$this->collBlocksPartial = $v;
}
/**
* Initializes the collBlocks collection.
*
* By default this just sets the collBlocks collection to an empty array (like clearcollBlocks());
* however, you may wish to override this method in your stub class to provide setting appropriate
* to your application -- for example, setting the initial array to the values stored in database.
*
* @param boolean $overrideExisting If set to true, the method call initializes
* the collection even if it is not empty
*
* @return void
*/
public function initBlocks($overrideExisting = true)
{
if (null !== $this->collBlocks && !$overrideExisting) {
return;
}
$this->collBlocks = new PropelObjectCollection();
$this->collBlocks->setModel('Block');
}
/**
* Gets an array of Block objects which contain a foreign key that references this object.
*
* If the $criteria is not null, it is used to always fetch the results from the database.
* Otherwise the results are fetched from the database the first time, then cached.
* Next time the same method is called without $criteria, the cached collection is returned.
* If this Model is new, it will return
* an empty collection or the current collection; the criteria is ignored on a new object.
*
* @param Criteria $criteria optional Criteria object to narrow the query
* @param PropelPDO $con optional connection object
* @return PropelObjectCollection|Block[] List of Block objects
* @throws PropelException
*/
public function getBlocks($criteria = null, PropelPDO $con = null)
{
$partial = $this->collBlocksPartial && !$this->isNew();
if (null === $this->collBlocks || null !== $criteria || $partial) {
if ($this->isNew() && null === $this->collBlocks) {
// return empty collection
$this->initBlocks();
} else {
$collBlocks = BlockQuery::create(null, $criteria)
->filterByModel($this)
->find($con);
if (null !== $criteria) {
if (false !== $this->collBlocksPartial && count($collBlocks)) {
$this->initBlocks(false);
foreach ($collBlocks as $obj) {
if (false == $this->collBlocks->contains($obj)) {
$this->collBlocks->append($obj);
}
}
$this->collBlocksPartial = true;
}
$collBlocks->getInternalIterator()->rewind();
return $collBlocks;
}
if ($partial && $this->collBlocks) {
foreach ($this->collBlocks as $obj) {
if ($obj->isNew()) {
$collBlocks[] = $obj;
}
}
}
$this->collBlocks = $collBlocks;
$this->collBlocksPartial = false;
}
}
return $this->collBlocks;
}
/**
* Sets a collection of Block objects related by a one-to-many relationship
* to the current object.
* It will also schedule objects for deletion based on a diff between old objects (aka persisted)
* and new objects from the given Propel collection.
*
* @param PropelCollection $blocks A Propel collection.
* @param PropelPDO $con Optional connection object
* @return Model The current object (for fluent API support)
*/
public function setBlocks(PropelCollection $blocks, PropelPDO $con = null)
{
$blocksToDelete = $this->getBlocks(new Criteria(), $con)->diff($blocks);
$this->blocksScheduledForDeletion = $blocksToDelete;
foreach ($blocksToDelete as $blockRemoved) {
$blockRemoved->setModel(null);
}
$this->collBlocks = null;
foreach ($blocks as $block) {
$this->addBlock($block);
}
$this->collBlocks = $blocks;
$this->collBlocksPartial = false;
return $this;
}
/**
* Returns the number of related Block objects.
*
* @param Criteria $criteria
* @param boolean $distinct
* @param PropelPDO $con
* @return int Count of related Block objects.
* @throws PropelException
*/
public function countBlocks(Criteria $criteria = null, $distinct = false, PropelPDO $con = null)
{
$partial = $this->collBlocksPartial && !$this->isNew();
if (null === $this->collBlocks || null !== $criteria || $partial) {
if ($this->isNew() && null === $this->collBlocks) {
return 0;
}
if ($partial && !$criteria) {
return count($this->getBlocks());
}
$query = BlockQuery::create(null, $criteria);
if ($distinct) {
$query->distinct();
}
return $query
->filterByModel($this)
->count($con);
}
return count($this->collBlocks);
}
/**
* Method called to associate a BaseBlock object to this object
* through the BaseBlock foreign key attribute.
*
* @param BaseBlock $l BaseBlock
* @return Model The current object (for fluent API support)
*/
public function addBlock(BaseBlock $l)
{
if ($this->collBlocks === null) {
$this->initBlocks();
$this->collBlocksPartial = true;
}
if (!in_array($l, $this->collBlocks->getArrayCopy(), true)) { // only add it if the **same** object is not already associated
$this->doAddBlock($l);
if ($this->blocksScheduledForDeletion and $this->blocksScheduledForDeletion->contains($l)) {
$this->blocksScheduledForDeletion->remove($this->blocksScheduledForDeletion->search($l));
}
}
return $this;
}
/**
* @param Block $block The block object to add.
*/
protected function doAddBlock($block)
{
$this->collBlocks[]= $block;
$block->setModel($this);
}
/**
* @param Block $block The block object to remove.
* @return Model The current object (for fluent API support)
*/
public function removeBlock($block)
{
if ($this->getBlocks()->contains($block)) {
$this->collBlocks->remove($this->collBlocks->search($block));
if (null === $this->blocksScheduledForDeletion) {
$this->blocksScheduledForDeletion = clone $this->collBlocks;
$this->blocksScheduledForDeletion->clear();
}
$this->blocksScheduledForDeletion[]= $block;
$block->setModel(null);
}
return $this;
}
/**
* Clears out the collModelVersions collection
*
* This does not modify the database; however, it will remove any associated objects, causing
* them to be refetched by subsequent calls to accessor method.
*
* @return Model The current object (for fluent API support)
* @see addModelVersions()
*/
public function clearModelVersions()
{
$this->collModelVersions = null; // important to set this to null since that means it is uninitialized
$this->collModelVersionsPartial = null;
return $this;
}
/**
* reset is the collModelVersions collection loaded partially
*
* @return void
*/
public function resetPartialModelVersions($v = true)
{
$this->collModelVersionsPartial = $v;
}
/**
* Initializes the collModelVersions collection.
*
* By default this just sets the collModelVersions collection to an empty array (like clearcollModelVersions());
* however, you may wish to override this method in your stub class to provide setting appropriate
* to your application -- for example, setting the initial array to the values stored in database.
*
* @param boolean $overrideExisting If set to true, the method call initializes
* the collection even if it is not empty
*
* @return void
*/
public function initModelVersions($overrideExisting = true)
{
if (null !== $this->collModelVersions && !$overrideExisting) {
return;
}
$this->collModelVersions = new PropelObjectCollection();
$this->collModelVersions->setModel('ModelVersion');
}
/**
* Gets an array of ModelVersion objects which contain a foreign key that references this object.
*
* If the $criteria is not null, it is used to always fetch the results from the database.
* Otherwise the results are fetched from the database the first time, then cached.
* Next time the same method is called without $criteria, the cached collection is returned.
* If this Model is new, it will return
* an empty collection or the current collection; the criteria is ignored on a new object.
*
* @param Criteria $criteria optional Criteria object to narrow the query
* @param PropelPDO $con optional connection object
* @return PropelObjectCollection|ModelVersion[] List of ModelVersion objects
* @throws PropelException
*/
public function getModelVersions($criteria = null, PropelPDO $con = null)
{
$partial = $this->collModelVersionsPartial && !$this->isNew();
if (null === $this->collModelVersions || null !== $criteria || $partial) {
if ($this->isNew() && null === $this->collModelVersions) {
// return empty collection
$this->initModelVersions();
} else {
$collModelVersions = ModelVersionQuery::create(null, $criteria)
->filterByModel($this)
->find($con);
if (null !== $criteria) {
if (false !== $this->collModelVersionsPartial && count($collModelVersions)) {
$this->initModelVersions(false);
foreach ($collModelVersions as $obj) {
if (false == $this->collModelVersions->contains($obj)) {
$this->collModelVersions->append($obj);
}
}
$this->collModelVersionsPartial = true;
}
$collModelVersions->getInternalIterator()->rewind();
return $collModelVersions;
}
if ($partial && $this->collModelVersions) {
foreach ($this->collModelVersions as $obj) {
if ($obj->isNew()) {
$collModelVersions[] = $obj;
}
}
}
$this->collModelVersions = $collModelVersions;
$this->collModelVersionsPartial = false;
}
}
return $this->collModelVersions;
}
/**
* Sets a collection of ModelVersion objects related by a one-to-many relationship
* to the current object.
* It will also schedule objects for deletion based on a diff between old objects (aka persisted)
* and new objects from the given Propel collection.
*
* @param PropelCollection $modelVersions A Propel collection.
* @param PropelPDO $con Optional connection object
* @return Model The current object (for fluent API support)
*/
public function setModelVersions(PropelCollection $modelVersions, PropelPDO $con = null)
{
$modelVersionsToDelete = $this->getModelVersions(new Criteria(), $con)->diff($modelVersions);
//since at least one column in the foreign key is at the same time a PK
//we can not just set a PK to NULL in the lines below. We have to store
//a backup of all values, so we are able to manipulate these items based on the onDelete value later.
$this->modelVersionsScheduledForDeletion = clone $modelVersionsToDelete;
foreach ($modelVersionsToDelete as $modelVersionRemoved) {
$modelVersionRemoved->setModel(null);
}
$this->collModelVersions = null;
foreach ($modelVersions as $modelVersion) {
$this->addModelVersion($modelVersion);
}
$this->collModelVersions = $modelVersions;
$this->collModelVersionsPartial = false;
return $this;
}
/**
* Returns the number of related ModelVersion objects.
*
* @param Criteria $criteria
* @param boolean $distinct
* @param PropelPDO $con
* @return int Count of related ModelVersion objects.
* @throws PropelException
*/
public function countModelVersions(Criteria $criteria = null, $distinct = false, PropelPDO $con = null)
{
$partial = $this->collModelVersionsPartial && !$this->isNew();
if (null === $this->collModelVersions || null !== $criteria || $partial) {
if ($this->isNew() && null === $this->collModelVersions) {
return 0;
}
if ($partial && !$criteria) {
return count($this->getModelVersions());
}
$query = ModelVersionQuery::create(null, $criteria);
if ($distinct) {
$query->distinct();
}
return $query
->filterByModel($this)
->count($con);
}
return count($this->collModelVersions);
}
/**
* Method called to associate a BaseModelVersion object to this object
* through the BaseModelVersion foreign key attribute.
*
* @param BaseModelVersion $l BaseModelVersion
* @return Model The current object (for fluent API support)
*/
public function addModelVersion(BaseModelVersion $l)
{
if ($this->collModelVersions === null) {
$this->initModelVersions();
$this->collModelVersionsPartial = true;
}
if (!in_array($l, $this->collModelVersions->getArrayCopy(), true)) { // only add it if the **same** object is not already associated
$this->doAddModelVersion($l);
if ($this->modelVersionsScheduledForDeletion and $this->modelVersionsScheduledForDeletion->contains($l)) {
$this->modelVersionsScheduledForDeletion->remove($this->modelVersionsScheduledForDeletion->search($l));
}
}
return $this;
}
/**
* @param ModelVersion $modelVersion The modelVersion object to add.
*/
protected function doAddModelVersion($modelVersion)
{
$this->collModelVersions[]= $modelVersion;
$modelVersion->setModel($this);
}
/**
* @param ModelVersion $modelVersion The modelVersion object to remove.
* @return Model The current object (for fluent API support)
*/
public function removeModelVersion($modelVersion)
{
if ($this->getModelVersions()->contains($modelVersion)) {
$this->collModelVersions->remove($this->collModelVersions->search($modelVersion));
if (null === $this->modelVersionsScheduledForDeletion) {
$this->modelVersionsScheduledForDeletion = clone $this->collModelVersions;
$this->modelVersionsScheduledForDeletion->clear();
}
$this->modelVersionsScheduledForDeletion[]= clone $modelVersion;
$modelVersion->setModel(null);
}
return $this;
}
/**
* Clears the current object and sets all attributes to their default values
*/
public function clear()
{
$this->id = null;
$this->name = null;
$this->template = null;
$this->class_key = null;
$this->created_at = null;
$this->updated_at = null;
$this->version = null;
$this->version_created_at = null;
$this->version_created_by = null;
$this->alreadyInSave = false;
$this->alreadyInValidation = false;
$this->alreadyInClearAllReferencesDeep = false;
$this->clearAllReferences();
$this->applyDefaultValues();
$this->resetModified();
$this->setNew(true);
$this->setDeleted(false);
}
/**
* Resets all references to other model objects or collections of model objects.
*
* This method is a user-space workaround for PHP's inability to garbage collect
* objects with circular references (even in PHP 5.3). This is currently necessary
* when using Propel in certain daemon or large-volume/high-memory operations.
*
* @param boolean $deep Whether to also clear the references on all referrer objects.
*/
public function clearAllReferences($deep = false)
{
if ($deep && !$this->alreadyInClearAllReferencesDeep) {
$this->alreadyInClearAllReferencesDeep = true;
if ($this->collNewsletters) {
foreach ($this->collNewsletters as $o) {
$o->clearAllReferences($deep);
}
}
if ($this->collBlocks) {
foreach ($this->collBlocks as $o) {
$o->clearAllReferences($deep);
}
}
if ($this->collModelVersions) {
foreach ($this->collModelVersions as $o) {
$o->clearAllReferences($deep);
}
}
$this->alreadyInClearAllReferencesDeep = false;
} // if ($deep)
if ($this->collNewsletters instanceof PropelCollection) {
$this->collNewsletters->clearIterator();
}
$this->collNewsletters = null;
if ($this->collBlocks instanceof PropelCollection) {
$this->collBlocks->clearIterator();
}
$this->collBlocks = null;
if ($this->collModelVersions instanceof PropelCollection) {
$this->collModelVersions->clearIterator();
}
$this->collModelVersions = null;
}
/**
* return the string representation of this object
*
* @return string
*/
public function __toString()
{
return (string) $this->exportTo(ModelPeer::DEFAULT_STRING_FORMAT);
}
/**
* return true is the object is in saving state
*
* @return boolean
*/
public function isAlreadyInSave()
{
return $this->alreadyInSave;
}
// timestampable behavior
/**
* Mark the current object so that the update date doesn't get updated during next save
*
* @return Model The current object (for fluent API support)
*/
public function keepUpdateDateUnchanged()
{
$this->modifiedColumns[] = ModelPeer::UPDATED_AT;
return $this;
}
// versionable behavior
/**
* Enforce a new Version of this object upon next save.
*
* @return Model
*/
public function enforceVersioning()
{
$this->enforceVersion = true;
return $this;
}
/**
* Checks whether the current state must be recorded as a version
*
* @param PropelPDO $con An optional PropelPDO connection to use.
*
* @return boolean
*/
public function isVersioningNecessary($con = null)
{
if ($this->alreadyInSave) {
return false;
}
if ($this->enforceVersion) {
return true;
}
if (ModelPeer::isVersioningEnabled() && ($this->isNew() || $this->isModified() || $this->isDeleted())) {
return true;
}
if ($this->collBlocks) {
// to avoid infinite loops, emulate in save
$this->alreadyInSave = true;
foreach ($this->getBlocks(null, $con) as $relatedObject) {
if ($relatedObject->isVersioningNecessary($con)) {
$this->alreadyInSave = false;
return true;
}
}
$this->alreadyInSave = false;
}
return false;
}
/**
* Creates a version of the current object and saves it.
*
* @param PropelPDO $con the connection to use
*
* @return ModelVersion A version object
*/
public function addVersion($con = null)
{
$this->enforceVersion = false;
$version = new ModelVersion();
$version->setId($this->getId());
$version->setName($this->getName());
$version->setTemplate($this->getTemplate());
$version->setClassKey($this->getClassKey());
$version->setCreatedAt($this->getCreatedAt());
$version->setUpdatedAt($this->getUpdatedAt());
$version->setVersion($this->getVersion());
$version->setVersionCreatedAt($this->getVersionCreatedAt());
$version->setVersionCreatedBy($this->getVersionCreatedBy());
$version->setModel($this);
if ($relateds = $this->getBlocks($con)->toKeyValue('Id', 'Version')) {
$version->setNwsBlockIds(array_keys($relateds));
$version->setNwsBlockVersions(array_values($relateds));
}
$version->save($con);
return $version;
}
/**
* Sets the properties of the current object to the value they had at a specific version
*
* @param integer $versionNumber The version number to read
* @param PropelPDO $con the connection to use
*
* @return Model The current object (for fluent API support)
* @throws PropelException - if no object with the given version can be found.
*/
public function toVersion($versionNumber, $con = null)
{
$version = $this->getOneVersion($versionNumber, $con);
if (!$version) {
throw new PropelException(sprintf('No Model object found with version %d', $versionNumber));
}
$this->populateFromVersion($version, $con);
return $this;
}
/**
* Sets the properties of the curent object to the value they had at a specific version
*
* @param ModelVersion $version The version object to use
* @param PropelPDO $con the connection to use
* @param array $loadedObjects objects thats been loaded in a chain of populateFromVersion calls on referrer or fk objects.
*
* @return Model The current object (for fluent API support)
*/
public function populateFromVersion($version, $con = null, &$loadedObjects = array())
{
$loadedObjects['Model'][$version->getId()][$version->getVersion()] = $this;
$this->setId($version->getId());
$this->setName($version->getName());
$this->setTemplate($version->getTemplate());
$this->setClassKey($version->getClassKey());
$this->setCreatedAt($version->getCreatedAt());
$this->setUpdatedAt($version->getUpdatedAt());
$this->setVersion($version->getVersion());
$this->setVersionCreatedAt($version->getVersionCreatedAt());
$this->setVersionCreatedBy($version->getVersionCreatedBy());
if ($fkValues = $version->getNwsBlockIds()) {
$this->clearBlocks();
$fkVersions = $version->getNwsBlockVersions();
$query = BlockVersionQuery::create();
foreach ($fkValues as $key => $value) {
$c1 = $query->getNewCriterion(BlockVersionPeer::ID, $value);
$c2 = $query->getNewCriterion(BlockVersionPeer::VERSION, $fkVersions[$key]);
$c1->addAnd($c2);
$query->addOr($c1);
}
foreach ($query->find($con) as $relatedVersion) {
if (isset($loadedObjects['Block']) && isset($loadedObjects['Block'][$relatedVersion->getId()]) && isset($loadedObjects['Block'][$relatedVersion->getId()][$relatedVersion->getVersion()])) {
$related = $loadedObjects['Block'][$relatedVersion->getId()][$relatedVersion->getVersion()];
} else {
$related = new Block();
$related->populateFromVersion($relatedVersion, $con, $loadedObjects);
$related->setNew(false);
}
$this->addBlock($related);
}
$this->resetPartialBlocks(false);
}
return $this;
}
/**
* Gets the latest persisted version number for the current object
*
* @param PropelPDO $con the connection to use
*
* @return integer
*/
public function getLastVersionNumber($con = null)
{
$v = ModelVersionQuery::create()
->filterByModel($this)
->orderByVersion('desc')
->findOne($con);
if (!$v) {
return 0;
}
return $v->getVersion();
}
/**
* Checks whether the current object is the latest one
*
* @param PropelPDO $con the connection to use
*
* @return boolean
*/
public function isLastVersion($con = null)
{
return $this->getLastVersionNumber($con) == $this->getVersion();
}
/**
* Retrieves a version object for this entity and a version number
*
* @param integer $versionNumber The version number to read
* @param PropelPDO $con the connection to use
*
* @return ModelVersion A version object
*/
public function getOneVersion($versionNumber, $con = null)
{
return ModelVersionQuery::create()
->filterByModel($this)
->filterByVersion($versionNumber)
->findOne($con);
}
/**
* Gets all the versions of this object, in incremental order
*
* @param PropelPDO $con the connection to use
*
* @return PropelObjectCollection A list of ModelVersion objects
*/
public function getAllVersions($con = null)
{
$criteria = new Criteria();
$criteria->addAscendingOrderByColumn(ModelVersionPeer::VERSION);
return $this->getModelVersions($criteria, $con);
}
/**
* Compares the current object with another of its version.
* <code>
* print_r($book->compareVersion(1));
* => array(
* '1' => array('Title' => 'Book title at version 1'),
* '2' => array('Title' => 'Book title at version 2')
* );
* </code>
*
* @param integer $versionNumber
* @param string $keys Main key used for the result diff (versions|columns)
* @param PropelPDO $con the connection to use
* @param array $ignoredColumns The columns to exclude from the diff.
*
* @return array A list of differences
*/
public function compareVersion($versionNumber, $keys = 'columns', $con = null, $ignoredColumns = array())
{
$fromVersion = $this->toArray();
$toVersion = $this->getOneVersion($versionNumber, $con)->toArray();
return $this->computeDiff($fromVersion, $toVersion, $keys, $ignoredColumns);
}
/**
* Compares two versions of the current object.
* <code>
* print_r($book->compareVersions(1, 2));
* => array(
* '1' => array('Title' => 'Book title at version 1'),
* '2' => array('Title' => 'Book title at version 2')
* );
* </code>
*
* @param integer $fromVersionNumber
* @param integer $toVersionNumber
* @param string $keys Main key used for the result diff (versions|columns)
* @param PropelPDO $con the connection to use
* @param array $ignoredColumns The columns to exclude from the diff.
*
* @return array A list of differences
*/
public function compareVersions($fromVersionNumber, $toVersionNumber, $keys = 'columns', $con = null, $ignoredColumns = array())
{
$fromVersion = $this->getOneVersion($fromVersionNumber, $con)->toArray();
$toVersion = $this->getOneVersion($toVersionNumber, $con)->toArray();
return $this->computeDiff($fromVersion, $toVersion, $keys, $ignoredColumns);
}
/**
* Computes the diff between two versions.
* <code>
* print_r($this->computeDiff(1, 2));
* => array(
* '1' => array('Title' => 'Book title at version 1'),
* '2' => array('Title' => 'Book title at version 2')
* );
* </code>
*
* @param array $fromVersion An array representing the original version.
* @param array $toVersion An array representing the destination version.
* @param string $keys Main key used for the result diff (versions|columns).
* @param array $ignoredColumns The columns to exclude from the diff.
*
* @return array A list of differences
*/
protected function computeDiff($fromVersion, $toVersion, $keys = 'columns', $ignoredColumns = array())
{
$fromVersionNumber = $fromVersion['Version'];
$toVersionNumber = $toVersion['Version'];
$ignoredColumns = array_merge(array(
'Version',
'VersionCreatedAt',
'VersionCreatedBy',
), $ignoredColumns);
$diff = array();
foreach ($fromVersion as $key => $value) {
if (in_array($key, $ignoredColumns)) {
continue;
}
if ($toVersion[$key] != $value) {
switch ($keys) {
case 'versions':
$diff[$fromVersionNumber][$key] = $value;
$diff[$toVersionNumber][$key] = $toVersion[$key];
break;
default:
$diff[$key] = array(
$fromVersionNumber => $value,
$toVersionNumber => $toVersion[$key],
);
break;
}
}
}
return $diff;
}
/**
* retrieve the last $number versions.
*
* @param integer $number the number of record to return.
* @param ModelVersionQuery|Criteria $criteria Additional criteria to filter.
* @param PropelPDO $con An optional connection to use.
*
* @return PropelCollection|ModelVersion[] List of ModelVersion objects
*/
public function getLastVersions($number = 10, $criteria = null, PropelPDO $con = null)
{
$criteria = ModelVersionQuery::create(null, $criteria);
$criteria->addDescendingOrderByColumn(ModelVersionPeer::VERSION);
$criteria->limit($number);
return $this->getModelVersions($criteria, $con);
}
// event behavior
public function preCommit(\PropelPDO $con = null){}
public function preCommitSave(\PropelPDO $con = null){}
public function preCommitDelete(\PropelPDO $con = null){}
public function preCommitUpdate(\PropelPDO $con = null){}
public function preCommitInsert(\PropelPDO $con = null){}
public function preRollback(\PropelPDO $con = null){}
public function preRollbackSave(\PropelPDO $con = null){}
public function preRollbackDelete(\PropelPDO $con = null){}
public function preRollbackUpdate(\PropelPDO $con = null){}
public function preRollbackInsert(\PropelPDO $con = null){}
}