2112 lines
66 KiB
PHP
2112 lines
66 KiB
PHP
<?php
|
|
/*
|
|
* $Id: Record.php 4342 2008-05-08 14:17:35Z romanb $
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the LGPL. For more information, see
|
|
* <http://www.phpdoctrine.org>.
|
|
*/
|
|
|
|
#namespace Doctrine::ORM;
|
|
|
|
/**
|
|
* Doctrine_Entity
|
|
* All record classes should inherit this super class
|
|
*
|
|
* @package Doctrine
|
|
* @subpackage Entity
|
|
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.phpdoctrine.org
|
|
* @since 2.0
|
|
* @version $Revision: 4342 $
|
|
* @todo Rename to "Entity". Split up into "Entity" and "ActiveEntity (extends Entity)"???
|
|
* @todo Remove as many methods as possible.
|
|
*/
|
|
abstract class Doctrine_Entity extends Doctrine_Access implements Countable, IteratorAggregate, Serializable
|
|
{
|
|
/**
|
|
* STATE CONSTANTS
|
|
*/
|
|
|
|
/**
|
|
* DIRTY STATE
|
|
* a Doctrine_Entity is in dirty state when its properties are changed
|
|
*/
|
|
const STATE_DIRTY = 1;
|
|
|
|
/**
|
|
* TDIRTY STATE
|
|
* a Doctrine_Entity is in transient dirty state when it is created
|
|
* and some of its fields are modified but it is NOT yet persisted into database
|
|
*/
|
|
const STATE_TDIRTY = 2;
|
|
|
|
/**
|
|
* CLEAN STATE
|
|
* a Doctrine_Entity is in clean state when all of its properties are loaded from the database
|
|
* and none of its properties are changed
|
|
*/
|
|
const STATE_CLEAN = 3;
|
|
|
|
/**
|
|
* PROXY STATE
|
|
* a Doctrine_Entity is in proxy state when its properties are not fully loaded
|
|
*/
|
|
const STATE_PROXY = 4;
|
|
|
|
/**
|
|
* NEW TCLEAN
|
|
* a Doctrine_Entity is in transient clean state when it is created and none of its fields are modified
|
|
*/
|
|
const STATE_TCLEAN = 5;
|
|
|
|
/**
|
|
* LOCKED STATE
|
|
* a Doctrine_Entity is temporarily locked during deletes and saves
|
|
*
|
|
* This state is used internally to ensure that circular deletes
|
|
* and saves will not cause infinite loops
|
|
*/
|
|
const STATE_LOCKED = 6;
|
|
|
|
/**
|
|
* Index used for creating object identifiers (oid's).
|
|
*
|
|
* @var integer $index
|
|
*/
|
|
private static $_index = 1;
|
|
|
|
/**
|
|
* Boolean flag that indicates whether automatic accessor overriding is enabled.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
private static $_useAutoAccessorOverride;
|
|
|
|
/**
|
|
* The accessor cache is used as a memory for the existance of custom accessors
|
|
* for fields.
|
|
*
|
|
* @var array
|
|
*/
|
|
private static $_accessorCache = array();
|
|
|
|
/**
|
|
* The mutator cache is used as a memory for the existance of custom mutators
|
|
* for fields.
|
|
*
|
|
* @var array
|
|
*/
|
|
private static $_mutatorCache = array();
|
|
|
|
/**
|
|
* The metadata container that describes the entity class.
|
|
*
|
|
* @var Doctrine_ClassMetadata
|
|
* @todo Lazy initialization.
|
|
*/
|
|
protected $_class;
|
|
|
|
/**
|
|
* The name of the Entity.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $_entityName;
|
|
|
|
/**
|
|
* @var Doctrine_Node_<TreeImpl> node object
|
|
* @todo Specific to the NestedSet Behavior plugin. Move outta here.
|
|
*/
|
|
protected $_node;
|
|
|
|
/**
|
|
* The values that make up the ID/primary key of the object.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_id = array();
|
|
|
|
/**
|
|
* The record data.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_data = array();
|
|
|
|
/**
|
|
* The values array, aggregate values and such are mapped into this array.
|
|
*
|
|
* @var array
|
|
* @todo Remove.
|
|
*/
|
|
protected $_values = array();
|
|
|
|
/**
|
|
* The state of the object.
|
|
*
|
|
* @var integer
|
|
* @see STATE_* constants
|
|
*/
|
|
protected $_state;
|
|
|
|
/**
|
|
* The names of fields that have been modified but not yet persisted.
|
|
*
|
|
* @var array
|
|
* @todo Better name? $_modifiedFields?
|
|
*/
|
|
protected $_modified = array();
|
|
|
|
/**
|
|
* The error stack used to collect errors during validation.
|
|
*
|
|
* @var Doctrine_Validator_ErrorStack
|
|
* @internal Uses lazy initialization to reduce memory usage.
|
|
*/
|
|
protected $_errorStack;
|
|
|
|
/**
|
|
* The references for all associations of the entity to other entities.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_references = array();
|
|
|
|
/**
|
|
* The EntityManager that is responsible for the persistence of the entity.
|
|
*
|
|
* @var Doctrine_EntityManager
|
|
* @todo Lazy initialization.
|
|
*/
|
|
protected $_em;
|
|
|
|
/**
|
|
* The object identifier of the object. Each object has a unique identifier during runtime.
|
|
*
|
|
* @var integer
|
|
*/
|
|
private $_oid;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param Doctrine_Table|null $table a Doctrine_Table object or null,
|
|
* if null the table object is retrieved from current connection
|
|
*
|
|
* @param boolean $isNewEntry whether or not this record is transient
|
|
*
|
|
* @throws Doctrine_Connection_Exception if object is created using the new operator and there are no
|
|
* open connections
|
|
* @throws Doctrine_Record_Exception if the cleanData operation fails somehow
|
|
* @todo Remove all parameters.
|
|
*/
|
|
public function __construct($isNewEntry = true, array $data = array())
|
|
{
|
|
$this->_entityName = get_class($this);
|
|
$this->_em = Doctrine_EntityManager::getManager($this->_entityName);
|
|
$this->_class = $this->_em->getClassMetadata($this->_entityName);
|
|
$this->_oid = self::$_index++;
|
|
|
|
|
|
// The following code inits data, id and state
|
|
|
|
// get the data array
|
|
$this->_data = $data;
|
|
|
|
// get the column count
|
|
$count = count($this->_data);
|
|
|
|
$this->_extractIdentifier( ! $isNewEntry);
|
|
|
|
if ($isNewEntry) {
|
|
if ($count > 0) {
|
|
$this->_state = Doctrine_Entity::STATE_TDIRTY;
|
|
} else {
|
|
$this->_state = Doctrine_Entity::STATE_TCLEAN;
|
|
}
|
|
// set the default values for this record
|
|
$this->assignDefaultValues();
|
|
} else {
|
|
// TODO: registerClean() on UnitOfWork
|
|
$this->_state = Doctrine_Entity::STATE_CLEAN;
|
|
if ($count < $this->_class->getColumnCount()) {
|
|
$this->_state = Doctrine_Entity::STATE_PROXY;
|
|
}
|
|
}
|
|
//--
|
|
|
|
self::$_useAutoAccessorOverride = true; // @todo read from attribute the first time
|
|
}
|
|
|
|
/**
|
|
* _index
|
|
*
|
|
* @return integer
|
|
*/
|
|
public static function _index()
|
|
{
|
|
return self::$_index;
|
|
}
|
|
|
|
/**
|
|
* construct
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the constructor procedure
|
|
*
|
|
* @return void
|
|
*/
|
|
public function construct()
|
|
{ }
|
|
|
|
/**
|
|
* getOid
|
|
* returns the object identifier
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getOid()
|
|
{
|
|
return $this->_oid;
|
|
}
|
|
|
|
/**
|
|
* isValid
|
|
*
|
|
* @return boolean whether or not this record is valid
|
|
* @todo Move to new Validator implementation (once we have it).
|
|
*/
|
|
public function isValid()
|
|
{
|
|
if ( ! $this->_class->getAttribute(Doctrine::ATTR_VALIDATE)) {
|
|
return true;
|
|
}
|
|
|
|
// Clear the stack from any previous errors.
|
|
$this->getErrorStack()->clear();
|
|
|
|
// Run validation process
|
|
$validator = new Doctrine_Validator();
|
|
$validator->validateRecord($this);
|
|
$this->validate();
|
|
if ($this->_state == self::STATE_TDIRTY || $this->_state == self::STATE_TCLEAN) {
|
|
$this->validateOnInsert();
|
|
} else {
|
|
$this->validateOnUpdate();
|
|
}
|
|
|
|
return $this->getErrorStack()->count() == 0 ? true : false;
|
|
}
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the validation procedure, doing any custom / specialized
|
|
* validations that are neccessary.
|
|
*
|
|
* @todo Move to new Validator implementation (once we have it).
|
|
*/
|
|
protected function validate()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the validation procedure only when the record is going to be
|
|
* updated.
|
|
*
|
|
* @todo Move to new Validator implementation (once we have it).
|
|
*/
|
|
protected function validateOnUpdate()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the validation procedure only when the record is going to be
|
|
* inserted into the data store the first time.
|
|
*
|
|
* @todo Move to new Validator implementation (once we have it).
|
|
*/
|
|
protected function validateOnInsert()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the serializing procedure.
|
|
*/
|
|
public function preSerialize()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the serializing procedure.
|
|
*/
|
|
public function postSerialize()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the serializing procedure.
|
|
*/
|
|
public function preUnserialize()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the serializing procedure.
|
|
*/
|
|
public function postUnserialize()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the saving procedure.
|
|
*/
|
|
public function preSave()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the saving procedure.
|
|
*/
|
|
public function postSave()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the deletion procedure.
|
|
*/
|
|
public function preDelete()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the deletion procedure.
|
|
*/
|
|
public function postDelete()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the saving procedure only when the record is going to be
|
|
* updated.
|
|
*/
|
|
public function preUpdate()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the saving procedure only when the record is going to be
|
|
* updated.
|
|
*/
|
|
public function postUpdate()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the saving procedure only when the record is going to be
|
|
* inserted into the data store the first time.
|
|
*/
|
|
public function preInsert()
|
|
{ }
|
|
|
|
/**
|
|
* Empty template method to provide concrete Record classes with the possibility
|
|
* to hook into the saving procedure only when the record is going to be
|
|
* inserted into the data store the first time.
|
|
*/
|
|
public function postInsert()
|
|
{ }
|
|
|
|
/**
|
|
* getErrorStack
|
|
*
|
|
* @return Doctrine_Validator_ErrorStack returns the errorStack associated with this record
|
|
* @todo Move to new Validator implementation (once we have it).
|
|
*/
|
|
public function getErrorStack()
|
|
{
|
|
if (is_null($this->_errorStack)) {
|
|
$this->_errorStack = new Doctrine_Validator_ErrorStack();
|
|
}
|
|
return $this->_errorStack;
|
|
}
|
|
|
|
/**
|
|
* errorStack
|
|
* assigns / returns record errorStack
|
|
*
|
|
* @param Doctrine_Validator_ErrorStack errorStack to be assigned for this record
|
|
* @return void|Doctrine_Validator_ErrorStack returns the errorStack associated with this record
|
|
* @todo Move to new Validator implementation (once we have it).
|
|
*/
|
|
public function errorStack($stack = null)
|
|
{
|
|
if ($stack !== null) {
|
|
if ( ! ($stack instanceof Doctrine_Validator_ErrorStack)) {
|
|
throw new Doctrine_Entity_Exception('Argument should be an instance of Doctrine_Validator_ErrorStack.');
|
|
}
|
|
$this->_errorStack = $stack;
|
|
} else {
|
|
return $this->getErrorStack();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* setDefaultValues
|
|
* sets the default values for records internal data
|
|
*
|
|
* @param boolean $overwrite whether or not to overwrite the already set values
|
|
* @return boolean
|
|
* @todo Job of EntityManager.
|
|
*/
|
|
public function assignDefaultValues($overwrite = false)
|
|
{
|
|
if ( ! $this->_class->hasDefaultValues()) {
|
|
return false;
|
|
}
|
|
foreach ($this->_data as $column => $value) {
|
|
$default = $this->_class->getDefaultValueOf($column);
|
|
|
|
if ($default === null) {
|
|
continue;
|
|
}
|
|
|
|
if ($value === Doctrine_Null::$INSTANCE || $overwrite) {
|
|
$this->_data[$column] = $default;
|
|
$this->_modified[] = $column;
|
|
$this->_state = Doctrine_Entity::STATE_TDIRTY;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* cleanData
|
|
* leaves the $data array only with values whose key is a field inside this
|
|
* record and returns the values that were removed from $data. Also converts
|
|
* any values of 'null' to objects of type Doctrine_Null.
|
|
*
|
|
* @param array $data data array to be cleaned
|
|
* @return array $tmp values cleaned from data
|
|
* @todo Remove. Should not be necessary. Slows down instantiation.
|
|
*/
|
|
public function cleanData(&$data)
|
|
{
|
|
$tmp = $data;
|
|
$data = array();
|
|
|
|
$fieldNames = $this->_em->getEntityPersister($this->_entityName)->getFieldNames();
|
|
foreach ($fieldNames as $fieldName) {
|
|
if (isset($tmp[$fieldName])) {
|
|
$data[$fieldName] = $tmp[$fieldName];
|
|
} else if (array_key_exists($fieldName, $tmp)) {
|
|
$data[$fieldName] = Doctrine_Null::$INSTANCE;
|
|
} else if ( ! isset($this->_data[$fieldName])) {
|
|
$data[$fieldName] = Doctrine_Null::$INSTANCE;
|
|
}
|
|
unset($tmp[$fieldName]);
|
|
}
|
|
|
|
return $tmp;
|
|
}
|
|
|
|
/**
|
|
* hydrate
|
|
* hydrates this object from given array
|
|
*
|
|
* @param array $data
|
|
* @return boolean
|
|
* @todo ActiveRecord method
|
|
*/
|
|
public function hydrate(array $data)
|
|
{
|
|
$this->_values = array_merge($this->_values, $this->cleanData($data));
|
|
$this->_data = array_merge($this->_data, $data);
|
|
$this->_extractIdentifier(true);
|
|
}
|
|
|
|
/**
|
|
* prepareIdentifiers
|
|
* prepares identifiers for later use
|
|
*
|
|
* @param boolean $exists whether or not this record exists in persistent data store
|
|
* @return void
|
|
* @todo Maybe better placed in the Mapper?
|
|
*/
|
|
private function _extractIdentifier($exists = true)
|
|
{
|
|
switch ($this->_class->getIdentifierType()) {
|
|
case Doctrine::IDENTIFIER_AUTOINC:
|
|
case Doctrine::IDENTIFIER_SEQUENCE:
|
|
case Doctrine::IDENTIFIER_NATURAL:
|
|
$name = $this->_class->getIdentifier();
|
|
$name = $name[0];
|
|
if ($exists) {
|
|
if (isset($this->_data[$name]) && $this->_data[$name] !== Doctrine_Null::$INSTANCE) {
|
|
$this->_id[$name] = $this->_data[$name];
|
|
}
|
|
}
|
|
break;
|
|
case Doctrine::IDENTIFIER_COMPOSITE:
|
|
$names = $this->_class->getIdentifier();
|
|
|
|
foreach ($names as $name) {
|
|
if ($this->_data[$name] === Doctrine_Null::$INSTANCE) {
|
|
$this->_id[$name] = null;
|
|
} else {
|
|
$this->_id[$name] = $this->_data[$name];
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
*/
|
|
final public function setIdentifier(array $identifier)
|
|
{
|
|
$this->_id = $identifier;
|
|
}
|
|
|
|
/**
|
|
* Serializes the entity.
|
|
* This method is automatically called when the entity is serialized.
|
|
*
|
|
* Part of the implementation of the Serializable interface.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function serialize()
|
|
{
|
|
$event = new Doctrine_Event($this, Doctrine_Event::RECORD_SERIALIZE);
|
|
$this->preSerialize($event);
|
|
|
|
$vars = get_object_vars($this);
|
|
|
|
unset($vars['_references']);
|
|
unset($vars['_mapper']);
|
|
unset($vars['_errorStack']);
|
|
unset($vars['_filter']);
|
|
unset($vars['_node']);
|
|
unset($vars['_em']);
|
|
|
|
//$name = (array)$this->_table->getIdentifier();
|
|
$this->_data = array_merge($this->_data, $this->_id);
|
|
|
|
foreach ($this->_data as $k => $v) {
|
|
if ($v instanceof Doctrine_Entity && $this->_class->getTypeOf($k) != 'object') {
|
|
unset($vars['_data'][$k]);
|
|
} else if ($v === Doctrine_Null::$INSTANCE) {
|
|
unset($vars['_data'][$k]);
|
|
} else {
|
|
switch ($this->_class->getTypeOf($k)) {
|
|
case 'array':
|
|
case 'object':
|
|
$vars['_data'][$k] = serialize($vars['_data'][$k]);
|
|
break;
|
|
case 'gzip':
|
|
$vars['_data'][$k] = gzcompress($vars['_data'][$k]);
|
|
break;
|
|
case 'enum':
|
|
$vars['_data'][$k] = $this->_class->enumIndex($k, $vars['_data'][$k]);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
$str = serialize($vars);
|
|
|
|
$this->postSerialize($event);
|
|
|
|
return $str;
|
|
}
|
|
|
|
/**
|
|
* Reconstructs the entity from it's serialized form.
|
|
* This method is automatically called everytime the entity is unserialized.
|
|
*
|
|
* @param string $serialized Doctrine_Entity as serialized string
|
|
* @throws Doctrine_Record_Exception if the cleanData operation fails somehow
|
|
* @return void
|
|
*/
|
|
public function unserialize($serialized)
|
|
{
|
|
$event = new Doctrine_Event($this, Doctrine_Event::RECORD_UNSERIALIZE);
|
|
|
|
$this->preUnserialize($event);
|
|
|
|
$this->_entityName = get_class($this);
|
|
$manager = Doctrine_EntityManager::getManager($this->_entityName);
|
|
$connection = $manager->getConnection();
|
|
|
|
$this->_oid = self::$_index;
|
|
self::$_index++;
|
|
|
|
$this->_em = $manager;
|
|
|
|
$array = unserialize($serialized);
|
|
|
|
foreach($array as $k => $v) {
|
|
$this->$k = $v;
|
|
}
|
|
|
|
$this->_class = $this->_em->getClassMetadata($this->_entityName);
|
|
|
|
foreach ($this->_data as $k => $v) {
|
|
switch ($this->_class->getTypeOf($k)) {
|
|
case 'array':
|
|
case 'object':
|
|
$this->_data[$k] = unserialize($this->_data[$k]);
|
|
break;
|
|
case 'gzip':
|
|
$this->_data[$k] = gzuncompress($this->_data[$k]);
|
|
break;
|
|
case 'enum':
|
|
$this->_data[$k] = $this->_class->enumValue($k, $this->_data[$k]);
|
|
break;
|
|
|
|
}
|
|
}
|
|
|
|
$this->cleanData($this->_data);
|
|
$this->_extractIdentifier($this->exists());
|
|
|
|
$this->postUnserialize($event);
|
|
}
|
|
|
|
/**
|
|
* state
|
|
* returns / assigns the state of this record
|
|
*
|
|
* @param integer|string $state if set, this method tries to set the record state to $state
|
|
* @see Doctrine_Entity::STATE_* constants
|
|
*
|
|
* @throws Doctrine_Record_State_Exception if trying to set an unknown state
|
|
* @return null|integer
|
|
*/
|
|
public function state($state = null)
|
|
{
|
|
if ($state == null) {
|
|
return $this->_state;
|
|
}
|
|
$err = false;
|
|
if (is_integer($state)) {
|
|
if ($state >= 1 && $state <= 6) {
|
|
$this->_state = $state;
|
|
} else {
|
|
$err = true;
|
|
}
|
|
} else if (is_string($state)) {
|
|
$upper = strtoupper($state);
|
|
|
|
$const = 'Doctrine_Entity::STATE_' . $upper;
|
|
if (defined($const)) {
|
|
$this->_state = constant($const);
|
|
} else {
|
|
$err = true;
|
|
}
|
|
}
|
|
|
|
if ($this->_state === Doctrine_Entity::STATE_TCLEAN ||
|
|
$this->_state === Doctrine_Entity::STATE_CLEAN) {
|
|
$this->_modified = array();
|
|
}
|
|
|
|
if ($err) {
|
|
throw new Doctrine_Record_Exception("Unknown record state '$state'.");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* refresh
|
|
* refresh internal data from the database
|
|
*
|
|
* @param bool $deep If true, fetch also current relations. Caution: this deletes
|
|
* any aggregated values you may have queried beforee
|
|
*
|
|
* @throws Doctrine_Record_Exception When the refresh operation fails (when the database row
|
|
* this record represents does not exist anymore)
|
|
* @return boolean
|
|
* @todo Implementation to EntityManager.
|
|
* @todo ActiveEntity method.
|
|
*/
|
|
public function refresh($deep = false)
|
|
{
|
|
$id = $this->identifier();
|
|
if ( ! is_array($id)) {
|
|
$id = array($id);
|
|
}
|
|
if (empty($id)) {
|
|
return false;
|
|
}
|
|
$id = array_values($id);
|
|
|
|
if ($deep) {
|
|
$query = $this->_class->getConnection()->createQuery()->from($this->_entityName);
|
|
foreach (array_keys($this->_references) as $name) {
|
|
$query->leftJoin(get_class($this) . '.' . $name);
|
|
}
|
|
$query->where(implode(' = ? AND ', $this->_class->getIdentifierColumnNames()) . ' = ?');
|
|
$this->clearRelated();
|
|
$record = $query->fetchOne($id);
|
|
} else {
|
|
// Use FETCH_ARRAY to avoid clearing object relations
|
|
$record = $this->getRepository()->find($this->identifier(), Doctrine::HYDRATE_ARRAY);
|
|
if ($record) {
|
|
$this->hydrate($record);
|
|
}
|
|
}
|
|
|
|
if ($record === false) {
|
|
throw new Doctrine_Record_Exception('Failed to refresh. Record does not exist.');
|
|
}
|
|
|
|
$this->_modified = array();
|
|
|
|
$this->_extractIdentifier();
|
|
|
|
$this->_state = Doctrine_Entity::STATE_CLEAN;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* refresh
|
|
* refres data of related objects from the database
|
|
*
|
|
* @param string $name name of a related component.
|
|
* if set, this method only refreshes the specified related component
|
|
*
|
|
* @return Doctrine_Entity this object
|
|
* @todo Implementation to EntityManager.
|
|
* @todo ActiveEntity method.
|
|
*/
|
|
public function refreshRelated($name = null)
|
|
{
|
|
if (is_null($name)) {
|
|
foreach ($this->_class->getRelations() as $rel) {
|
|
$this->_references[$rel->getAlias()] = $rel->fetchRelatedFor($this);
|
|
}
|
|
} else {
|
|
$rel = $this->_class->getRelation($name);
|
|
$this->_references[$name] = $rel->fetchRelatedFor($this);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* clearRelated
|
|
* unsets all the relationships this object has
|
|
*
|
|
* (references to related objects still remain on Table objects)
|
|
*/
|
|
public function clearRelated()
|
|
{
|
|
$this->_references = array();
|
|
}
|
|
|
|
/**
|
|
* Gets the current property values.
|
|
*
|
|
* @return array The current properties and their values.
|
|
*/
|
|
public function getData()
|
|
{
|
|
return $this->_data;
|
|
}
|
|
|
|
/**
|
|
* @todo Remove.
|
|
*/
|
|
public function getValues()
|
|
{
|
|
return $this->_values;
|
|
}
|
|
|
|
/**
|
|
* Gets the value of a field (regular field or reference).
|
|
* If the property is not yet loaded this method does NOT load it.
|
|
*
|
|
* NOTE: Use of this method from outside the scope of an extending class
|
|
* is strongly discouraged.
|
|
*
|
|
* @param $name name of the property
|
|
* @throws Doctrine_Entity_Exception if trying to get an unknown field
|
|
* @return mixed
|
|
*/
|
|
public function rawGet($fieldName)
|
|
{
|
|
if (isset($this->_data[$fieldName])) {
|
|
return $this->rawGetField($fieldName);
|
|
} else if (isset($this->_references[$fieldName])) {
|
|
return $this->rawGetReference($fieldName);
|
|
} else {
|
|
throw Doctrine_Entity_Exception::unknownField($fieldName);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the value of a field.
|
|
*
|
|
* NOTE: Use of this method from outside the scope of an extending class
|
|
* is strongly discouraged. This method does NOT check whether the field
|
|
* exists.
|
|
*
|
|
* @param string $fieldName
|
|
* @return mixed
|
|
*/
|
|
public function rawGetField($fieldName)
|
|
{
|
|
if ($this->_data[$fieldName] === Doctrine_Null::$INSTANCE) {
|
|
return null;
|
|
}
|
|
return $this->_data[$fieldName];
|
|
}
|
|
|
|
/**
|
|
* Sets the value of a field.
|
|
*
|
|
* NOTE: Use of this method from outside the scope of an extending class
|
|
* is strongly discouraged. This method does NOT check whether the field
|
|
* exists.
|
|
*
|
|
* @param string $fieldName
|
|
* @param mixed $value
|
|
*/
|
|
public function rawSetField($fieldName, $value)
|
|
{
|
|
$this->_data[$fieldName] = $value;
|
|
}
|
|
|
|
/**
|
|
* Gets a reference to another Entity.
|
|
*
|
|
* NOTE: Use of this method from outside the scope of an extending class
|
|
* is strongly discouraged. This method does NOT check whether the reference
|
|
* exists.
|
|
*
|
|
* @param unknown_type $fieldName
|
|
*/
|
|
public function rawGetReference($fieldName)
|
|
{
|
|
if ($this->_references[$fieldName] === Doctrine_Null::$INSTANCE) {
|
|
return null;
|
|
}
|
|
return $this->_references[$fieldName];
|
|
}
|
|
|
|
/**
|
|
* Sets a reference to another Entity.
|
|
*
|
|
* NOTE: Use of this method from outside the scope of an extending class
|
|
* is strongly discouraged.
|
|
*
|
|
* @param unknown_type $fieldName
|
|
* @param unknown_type $value
|
|
* @todo Refactor. What about composite keys?
|
|
*/
|
|
public function rawSetReference($name, $value)
|
|
{
|
|
if ($value === Doctrine_Null::$INSTANCE) {
|
|
$this->_references[$name] = $value;
|
|
return;
|
|
}
|
|
|
|
$rel = $this->_class->getRelation($name);
|
|
|
|
// one-to-many or one-to-one relation
|
|
if ($rel instanceof Doctrine_Relation_ForeignKey ||
|
|
$rel instanceof Doctrine_Relation_LocalKey) {
|
|
if ( ! $rel->isOneToOne()) {
|
|
// one-to-many relation found
|
|
if ( ! $value instanceof Doctrine_Collection) {
|
|
throw Doctrine_Entity_Exception::invalidValueForOneToManyReference();
|
|
}
|
|
if (isset($this->_references[$name])) {
|
|
$this->_references[$name]->setData($value->getData());
|
|
return $this;
|
|
}
|
|
} else {
|
|
$relatedTable = $value->getTable();
|
|
$foreignFieldName = $rel->getForeignFieldName();
|
|
$localFieldName = $rel->getLocalFieldName();
|
|
|
|
// one-to-one relation found
|
|
if ( ! ($value instanceof Doctrine_Entity)) {
|
|
throw Doctrine_Entity_Exception::invalidValueForOneToOneReference();
|
|
}
|
|
if ($rel instanceof Doctrine_Relation_LocalKey) {
|
|
$idFieldNames = $value->getTable()->getIdentifier();
|
|
if ( ! empty($foreignFieldName) && $foreignFieldName != $idFieldNames[0]) {
|
|
$this->set($localFieldName, $value->rawGet($foreignFieldName), false);
|
|
} else {
|
|
$this->set($localFieldName, $value, false);
|
|
}
|
|
} else {
|
|
$value->set($foreignFieldName, $this, false);
|
|
}
|
|
}
|
|
} else if ($rel instanceof Doctrine_Relation_Association) {
|
|
if ( ! ($value instanceof Doctrine_Collection)) {
|
|
throw Doctrine_Entity_Exception::invalidValueForManyToManyReference();
|
|
}
|
|
}
|
|
|
|
$this->_references[$name] = $value;
|
|
}
|
|
|
|
/**
|
|
* load
|
|
* loads all the uninitialized properties from the database
|
|
*
|
|
* @return boolean
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function load()
|
|
{
|
|
// only load the data from database if the Doctrine_Entity is in proxy state
|
|
if ($this->_state == Doctrine_Entity::STATE_PROXY) {
|
|
$this->refresh();
|
|
$this->_state = Doctrine_Entity::STATE_CLEAN;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* get
|
|
* returns a value of a property or a related component
|
|
*
|
|
* @param mixed $name name of the property or related component
|
|
* @param boolean $load whether or not to invoke the loading procedure
|
|
* @throws Doctrine_Record_Exception if trying to get a value of unknown property / related component
|
|
* @return mixed
|
|
*/
|
|
public function get($fieldName, $load = false)
|
|
{
|
|
if ($getter = $this->_getCustomAccessor($fieldName)) {
|
|
return $this->$getter();
|
|
}
|
|
|
|
// Use built-in accessor functionality
|
|
$nullObj = Doctrine_Null::$INSTANCE;
|
|
if (isset($this->_data[$fieldName])) {
|
|
return $this->_data[$fieldName] !== $nullObj ?
|
|
$this->_data[$fieldName] : null;
|
|
} else if (isset($this->_references[$fieldName])) {
|
|
return $this->_references[$fieldName] !== $nullObj ?
|
|
$this->_references[$fieldName] : null;
|
|
} else {
|
|
if ($this->_class->hasField($fieldName)) {
|
|
if ($load) {
|
|
$this->load();
|
|
return $this->get($fieldName);
|
|
} else {
|
|
return null;
|
|
}
|
|
} else if ($this->_class->hasRelation($fieldName)) {
|
|
if ($load) {
|
|
$rel = $this->_class->getRelation($fieldName);
|
|
$this->_references[$fieldName] = $rel->fetchRelatedFor($this);
|
|
return $this->_references[$fieldName] !== $nullObj ?
|
|
$this->_references[$fieldName] : null;
|
|
} else {
|
|
return null;
|
|
}
|
|
} else {
|
|
throw Doctrine_Entity_Exception::invalidField($fieldName);
|
|
}
|
|
}
|
|
}
|
|
|
|
private function _getCustomMutator($fieldName)
|
|
{
|
|
if ( ! isset(self::$_mutatorCache[$this->_entityName][$fieldName])) {
|
|
if (self::$_useAutoAccessorOverride) {
|
|
$setterMethod = 'set' . Doctrine::classify($fieldName);
|
|
if (method_exists($this, $setterMethod)) {
|
|
self::$_mutatorCache[$this->_entityName][$fieldName] = $setterMethod;
|
|
} else {
|
|
self::$_mutatorCache[$this->_entityName][$fieldName] = false;
|
|
}
|
|
}
|
|
|
|
if ($setter = $this->_class->getCustomMutator($fieldName)) {
|
|
self::$_mutatorCache[$this->_entityName][$fieldName] = $setter;
|
|
} else if ( ! isset(self::$_mutatorCache[$this->_entityName][$fieldName])) {
|
|
self::$_mutatorCache[$this->_entityName][$fieldName] = false;
|
|
}
|
|
}
|
|
|
|
return self::$_mutatorCache[$this->_entityName][$fieldName];
|
|
}
|
|
|
|
private function _getCustomAccessor($fieldName)
|
|
{
|
|
if ( ! isset(self::$_accessorCache[$this->_entityName][$fieldName])) {
|
|
if (self::$_useAutoAccessorOverride) {
|
|
$getterMethod = 'get' . Doctrine::classify($fieldName);
|
|
if (method_exists($this, $getterMethod)) {
|
|
self::$_accessorCache[$this->_entityName][$fieldName] = $getterMethod;
|
|
} else {
|
|
self::$_accessorCache[$this->_entityName][$fieldName] = false;
|
|
}
|
|
}
|
|
if ($getter = $this->_class->getCustomAccessor($fieldName)) {
|
|
self::$_accessorCache[$this->_entityName][$fieldName] = $getter;
|
|
} else if ( ! isset(self::$_accessorCache[$this->_entityName][$fieldName])) {
|
|
self::$_accessorCache[$this->_entityName][$fieldName] = false;
|
|
}
|
|
}
|
|
|
|
return self::$_accessorCache[$this->_entityName][$fieldName];
|
|
}
|
|
|
|
public function getClassName()
|
|
{
|
|
return $this->_entityName;
|
|
}
|
|
|
|
/**
|
|
* set
|
|
* method for altering properties and Doctrine_Entity references
|
|
* if the load parameter is set to false this method will not try to load uninitialized record data
|
|
*
|
|
* @param mixed $name name of the property or reference
|
|
* @param mixed $value value of the property or reference
|
|
* @param boolean $load whether or not to refresh / load the uninitialized record data
|
|
*
|
|
* @throws Doctrine_Record_Exception if trying to set a value for unknown property / related component
|
|
* @throws Doctrine_Record_Exception if trying to set a value of wrong type for related component
|
|
*
|
|
* @return Doctrine_Entity
|
|
*/
|
|
public function set($fieldName, $value, $load = false)
|
|
{
|
|
if ($setter = $this->_getCustomMutator($fieldName)) {
|
|
return $this->$setter($value);
|
|
}
|
|
|
|
if ($this->_class->hasField($fieldName)) {
|
|
if ($value instanceof Doctrine_Entity) {
|
|
$type = $this->_class->getTypeOf($fieldName);
|
|
// FIXME: composite key support
|
|
$ids = $value->identifier();
|
|
$id = count($ids) > 0 ? array_pop($ids) : null;
|
|
if ($id !== null && $type !== 'object') {
|
|
$value = $id;
|
|
}
|
|
}
|
|
|
|
if ($load) {
|
|
$old = $this->get($fieldName, true);
|
|
} else {
|
|
$old = isset($this->_data[$fieldName]) ? $this->_data[$fieldName] : null;
|
|
}
|
|
|
|
if ($old !== $value) {
|
|
$this->_data[$fieldName] = $value;
|
|
$this->_modified[] = $fieldName;
|
|
|
|
/* We can't do this currently because there are tests that change
|
|
* the primary key of already persisted entities (ugh). */
|
|
if ($this->isTransient() && $this->_class->isIdentifier($fieldName)) {
|
|
$this->_id[$fieldName] = $value;
|
|
}
|
|
|
|
switch ($this->_state) {
|
|
case Doctrine_Entity::STATE_CLEAN:
|
|
$this->_state = Doctrine_Entity::STATE_DIRTY;
|
|
break;
|
|
case Doctrine_Entity::STATE_TCLEAN:
|
|
$this->_state = Doctrine_Entity::STATE_TDIRTY;
|
|
break;
|
|
}
|
|
}
|
|
} else if ($this->_class->hasRelation($fieldName)) {
|
|
$this->rawSetReference($fieldName, $value);
|
|
} else {
|
|
throw Doctrine_Entity_Exception::invalidField($fieldName);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* contains
|
|
*
|
|
* @param string $name
|
|
* @return boolean
|
|
*/
|
|
public function contains($fieldName)
|
|
{
|
|
if (isset($this->_data[$fieldName])) {
|
|
if ($this->_data[$fieldName] === Doctrine_Null::$INSTANCE) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
if (isset($this->_id[$fieldName])) {
|
|
return true;
|
|
}
|
|
if (isset($this->_values[$fieldName])) {
|
|
return true;
|
|
}
|
|
if (isset($this->_references[$fieldName]) &&
|
|
$this->_references[$fieldName] !== Doctrine_Null::$INSTANCE) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @return void
|
|
*/
|
|
public function remove($fieldName)
|
|
{
|
|
if (isset($this->_data[$fieldName])) {
|
|
$this->_data[$fieldName] = array();
|
|
} else if (isset($this->_references[$fieldName])) {
|
|
if ($this->_references[$fieldName] instanceof Doctrine_Entity) {
|
|
// todo: delete related record when saving $this
|
|
$this->_references[$fieldName] = Doctrine_Null::$INSTANCE;
|
|
} else if ($this->_references[$fieldName] instanceof Doctrine_Collection) {
|
|
$this->_references[$fieldName]->setData(array());
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Saves the current state of the entity into the database.
|
|
* This method also saves associated entities.
|
|
*
|
|
* @param Doctrine_Connection $conn optional connection parameter
|
|
* @return void
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function save(Doctrine_Connection $conn = null)
|
|
{
|
|
// TODO: Forward to EntityManager. There: registerNew() OR registerDirty() on UnitOfWork.
|
|
$this->_em->save($this, $conn);
|
|
}
|
|
|
|
/**
|
|
* Tries to save the object and all its related objects.
|
|
* In contrast to Doctrine_Entity::save(), this method does not
|
|
* throw an exception when validation fails but returns TRUE on
|
|
* success or FALSE on failure.
|
|
*
|
|
* @param Doctrine_Connection $conn optional connection parameter
|
|
* @return TRUE if the record was saved sucessfully without errors, FALSE otherwise.
|
|
* @todo ActiveRecord method. Find new place in new Validation system.
|
|
*/
|
|
public function trySave(Doctrine_Connection $conn = null) {
|
|
try {
|
|
$this->save($conn);
|
|
return true;
|
|
} catch (Doctrine_Validator_Exception $ignored) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* replace
|
|
* Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
|
|
* query, except that if there is already a row in the table with the same
|
|
* key field values, the REPLACE query just updates its values instead of
|
|
* inserting a new row.
|
|
*
|
|
* The REPLACE type of query does not make part of the SQL standards. Since
|
|
* practically only MySQL and SQLIte implement it natively, this type of
|
|
* query isemulated through this method for other DBMS using standard types
|
|
* of queries inside a transaction to assure the atomicity of the operation.
|
|
*
|
|
* @param Doctrine_Connection $conn optional connection parameter
|
|
* @throws Doctrine_Connection_Exception if some of the key values was null
|
|
* @throws Doctrine_Connection_Exception if there were no key fields
|
|
* @throws Doctrine_Connection_Exception if something fails at database level
|
|
* @return integer number of rows affected
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function replace(Doctrine_Connection $conn = null)
|
|
{
|
|
if ($conn === null) {
|
|
$conn = $this->_em;
|
|
}
|
|
|
|
return $conn->replace($this->_class, $this->getPrepared(), $this->_id);
|
|
}
|
|
|
|
/**
|
|
* returns an array of modified fields and associated values
|
|
* @return array
|
|
* @deprecated
|
|
*/
|
|
public function getModified()
|
|
{
|
|
return $this->getModifiedFields();
|
|
}
|
|
|
|
/**
|
|
* Gets the names and values of all fields that have been modified since
|
|
* the entity was last synch'd with the database.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getModifiedFields()
|
|
{
|
|
$a = array();
|
|
foreach ($this->_modified as $k => $v) {
|
|
$a[$v] = $this->_data[$v];
|
|
}
|
|
return $a;
|
|
}
|
|
|
|
/**
|
|
* getPrepared
|
|
*
|
|
* returns an array of modified fields and values with data preparation
|
|
* adds column aggregation inheritance and converts Records into primary key values
|
|
*
|
|
* @param array $array
|
|
* @return array
|
|
* @todo What about a little bit more expressive name? getPreparedData?
|
|
* @todo Maybe not the best place here ... need to think about it.
|
|
*/
|
|
public function getPrepared(array $array = array())
|
|
{
|
|
$dataSet = array();
|
|
|
|
if (empty($array)) {
|
|
$modifiedFields = $this->_modified;
|
|
}
|
|
|
|
foreach ($modifiedFields as $field) {
|
|
$type = $this->_class->getTypeOf($field);
|
|
|
|
if ($this->_data[$field] === Doctrine_Null::$INSTANCE) {
|
|
$dataSet[$field] = null;
|
|
continue;
|
|
}
|
|
|
|
switch ($type) {
|
|
case 'array':
|
|
case 'object':
|
|
$dataSet[$field] = serialize($this->_data[$field]);
|
|
break;
|
|
case 'gzip':
|
|
$dataSet[$field] = gzcompress($this->_data[$field],5);
|
|
break;
|
|
case 'boolean':
|
|
$dataSet[$field] = $this->getTable()->getConnection()->convertBooleans($this->_data[$field]);
|
|
break;
|
|
case 'enum':
|
|
$dataSet[$field] = $this->_class->enumIndex($field, $this->_data[$field]);
|
|
break;
|
|
default:
|
|
if ($this->_data[$field] instanceof Doctrine_Entity) {
|
|
// FIXME: composite key support
|
|
$ids = $this->_data[$field]->identifier();
|
|
$id = count($ids) > 0 ? array_pop($ids) : null;
|
|
$this->_data[$field] = $id;
|
|
}
|
|
/** TODO:
|
|
if ($this->_data[$v] === null) {
|
|
throw new Doctrine_Record_Exception('Unexpected null value.');
|
|
}
|
|
*/
|
|
|
|
$dataSet[$field] = $this->_data[$field];
|
|
}
|
|
}
|
|
|
|
// @todo cleanup
|
|
// populates the discriminator field in Single & Class Table Inheritance
|
|
if ($this->_class->getInheritanceType() == Doctrine::INHERITANCE_TYPE_JOINED ||
|
|
$this->_class->getInheritanceType() == Doctrine::INHERITANCE_TYPE_SINGLE_TABLE) {
|
|
$discCol = $this->_class->getInheritanceOption('discriminatorColumn');
|
|
$discMap = $this->_class->getInheritanceOption('discriminatorMap');
|
|
$old = $this->get($discCol, false);
|
|
$discValue = array_search($this->_entityName, $discMap);
|
|
if ((string) $old !== (string) $discValue || $old === null) {
|
|
$dataSet[$discCol] = $discValue;
|
|
$this->_data[$discCol] = $discValue;
|
|
}
|
|
}
|
|
|
|
return $dataSet;
|
|
}
|
|
|
|
/**
|
|
* count
|
|
* this class implements countable interface
|
|
*
|
|
* Implementation of the Countable interface.
|
|
*
|
|
* @return integer the number of columns in this record
|
|
* @todo IMHO this is unintuitive.
|
|
* @todo ActiveRecord method. (if at all)
|
|
*/
|
|
public function count()
|
|
{
|
|
return count($this->_data);
|
|
}
|
|
|
|
/**
|
|
* Creates an array representation of the object's data.
|
|
*
|
|
* @param boolean $deep - Return also the relations
|
|
* @return array
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function toArray($deep = true, $prefixKey = false)
|
|
{
|
|
$a = array();
|
|
|
|
foreach ($this as $column => $value) {
|
|
if ($value === Doctrine_Null::$INSTANCE || is_object($value)) {
|
|
$value = null;
|
|
}
|
|
$a[$column] = $value;
|
|
}
|
|
|
|
if ($this->_class->getIdentifierType() == Doctrine::IDENTIFIER_AUTOINC) {
|
|
$idFieldNames = (array)$this->_class->getIdentifier();
|
|
$idFieldName = $idFieldNames[0];
|
|
|
|
$ids = $this->identifier();
|
|
$id = count($ids) > 0 ? array_pop($ids) : null;
|
|
|
|
$a[$idFieldName] = $id;
|
|
}
|
|
|
|
if ($deep) {
|
|
foreach ($this->_references as $key => $relation) {
|
|
if ( ! $relation instanceof Doctrine_Null) {
|
|
$a[$key] = $relation->toArray($deep, $prefixKey);
|
|
}
|
|
}
|
|
}
|
|
|
|
// [FIX] Prevent mapped Doctrine_Entitys from being displayed fully
|
|
foreach ($this->_values as $key => $value) {
|
|
if ($value instanceof Doctrine_Entity) {
|
|
$a[$key] = $value->toArray($deep, $prefixKey);
|
|
} else {
|
|
$a[$key] = $value;
|
|
}
|
|
}
|
|
|
|
return $a;
|
|
}
|
|
|
|
/**
|
|
* Merges this record with an array of values
|
|
* or with another existing instance of this object
|
|
*
|
|
* @param mixed $data Data to merge. Either another instance of this model or an array
|
|
* @param bool $deep Bool value for whether or not to merge the data deep
|
|
* @return void
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function merge($data, $deep = true)
|
|
{
|
|
if ($data instanceof $this) {
|
|
$array = $data->toArray($deep);
|
|
} else if (is_array($data)) {
|
|
$array = $data;
|
|
} else {
|
|
$array = array();
|
|
}
|
|
|
|
return $this->fromArray($array, $deep);
|
|
}
|
|
|
|
/**
|
|
* fromArray
|
|
*
|
|
* @param string $array
|
|
* @param bool $deep Bool value for whether or not to merge the data deep
|
|
* @return void
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function fromArray($array, $deep = true)
|
|
{
|
|
if (is_array($array)) {
|
|
foreach ($array as $key => $value) {
|
|
if ($deep && $this->getTable()->hasRelation($key)) {
|
|
$this->$key->fromArray($value, $deep);
|
|
} else if ($this->getTable()->hasField($key)) {
|
|
$this->set($key, $value);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* synchronizeFromArray
|
|
* synchronizes a Doctrine_Entity and its relations with data from an array
|
|
*
|
|
* it expects an array representation of a Doctrine_Entity similar to the return
|
|
* value of the toArray() method. If the array contains relations it will create
|
|
* those that don't exist, update the ones that do, and delete the ones missing
|
|
* on the array but available on the Doctrine_Entity
|
|
*
|
|
* @param array $array representation of a Doctrine_Entity
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function synchronizeFromArray(array $array)
|
|
{
|
|
foreach ($array as $key => $value) {
|
|
if ($this->getTable()->hasRelation($key)) {
|
|
$this->get($key)->synchronizeFromArray($value);
|
|
} else if ($this->getTable()->hasColumn($key)) {
|
|
$this->set($key, $value);
|
|
}
|
|
}
|
|
// eliminate relationships missing in the $array
|
|
foreach ($this->_references as $name => $obj) {
|
|
if ( ! isset($array[$name])) {
|
|
unset($this->$name);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* exportTo
|
|
*
|
|
* @param string $type
|
|
* @param string $deep
|
|
* @return void
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function exportTo($type, $deep = true)
|
|
{
|
|
if ($type == 'array') {
|
|
return $this->toArray($deep);
|
|
} else {
|
|
return Doctrine_Parser::dump($this->toArray($deep, true), $type);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* importFrom
|
|
*
|
|
* @param string $type
|
|
* @param string $data
|
|
* @return void
|
|
* @author Jonathan H. Wage
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function importFrom($type, $data)
|
|
{
|
|
if ($type == 'array') {
|
|
return $this->fromArray($data);
|
|
} else {
|
|
return $this->fromArray(Doctrine_Parser::load($data, $type));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks whether the entity already has a persistent state.
|
|
*
|
|
* @return boolean TRUE if the object is managed and has persistent state, FALSE otherwise.
|
|
* @deprecated
|
|
*/
|
|
public function exists()
|
|
{
|
|
return ($this->_state !== Doctrine_Entity::STATE_TCLEAN &&
|
|
$this->_state !== Doctrine_Entity::STATE_TDIRTY);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the entity already has a persistent state.
|
|
*
|
|
* @return boolean TRUE if the object is new, FALSE otherwise.
|
|
* @deprecated Use isTransient()
|
|
*/
|
|
public function isNew()
|
|
{
|
|
return $this->_state == self::STATE_TCLEAN || $this->_state == self::STATE_TDIRTY;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the entity already has a persistent state.
|
|
*
|
|
* @return boolean TRUE if the object is new, FALSE otherwise.
|
|
*/
|
|
public function isTransient()
|
|
{
|
|
return $this->_state == self::STATE_TCLEAN || $this->_state == self::STATE_TDIRTY;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the entity has been modified since it was last synchronized
|
|
* with the database.
|
|
*
|
|
* @return boolean TRUE if the object has been modified, FALSE otherwise.
|
|
*/
|
|
public function isDirty()
|
|
{
|
|
return ($this->_state === Doctrine_Entity::STATE_DIRTY ||
|
|
$this->_state === Doctrine_Entity::STATE_TDIRTY);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the entity has been modified since it was last synchronized
|
|
* with the database.
|
|
*
|
|
* @return boolean TRUE if the object has been modified, FALSE otherwise.
|
|
* @deprecated Use isDirty()
|
|
*/
|
|
public function isModified()
|
|
{
|
|
return ($this->_state === Doctrine_Entity::STATE_DIRTY ||
|
|
$this->_state === Doctrine_Entity::STATE_TDIRTY);
|
|
}
|
|
|
|
/**
|
|
* method for checking existence of properties and Doctrine_Entity references
|
|
*
|
|
* @param mixed $name name of the property or reference
|
|
* @return boolean
|
|
* @todo Method name does not reflect the purpose.
|
|
*/
|
|
public function hasRelation($fieldName)
|
|
{
|
|
if (isset($this->_data[$fieldName]) || isset($this->_id[$fieldName])) {
|
|
return true;
|
|
}
|
|
return $this->_class->hasRelation($fieldName);
|
|
}
|
|
|
|
/**
|
|
* getIterator
|
|
* @return Doctrine_Record_Iterator a Doctrine_Record_Iterator that iterates through the data
|
|
* @todo Really needed/useful?
|
|
*/
|
|
public function getIterator()
|
|
{
|
|
return new Doctrine_Record_Iterator($this);
|
|
}
|
|
|
|
/**
|
|
* Deletes the entity.
|
|
*
|
|
* Triggered events: onPreDelete, onDelete.
|
|
*
|
|
* @return boolean true on success, false on failure
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function delete(Doctrine_Connection $conn = null)
|
|
{
|
|
// TODO: Forward to EntityManager. There: registerRemoved() on UnitOfWork
|
|
return $this->_em->remove($this, $conn);
|
|
}
|
|
|
|
/**
|
|
* Creates a copy of the entity.
|
|
*
|
|
* @return Doctrine_Entity
|
|
* @todo ActiveRecord method. Implementation to EntityManager.
|
|
*/
|
|
public function copy($deep = true)
|
|
{
|
|
$data = $this->_data;
|
|
|
|
if ($this->_class->getIdentifierType() === Doctrine::IDENTIFIER_AUTOINC) {
|
|
$idFieldNames = (array)$this->_class->getIdentifier();
|
|
$id = $idFieldNames[0];
|
|
unset($data[$id]);
|
|
}
|
|
|
|
$ret = $this->_em->createEntity($this->_entityName, $data);
|
|
$modified = array();
|
|
|
|
foreach ($data as $key => $val) {
|
|
if ( ! ($val instanceof Doctrine_Null)) {
|
|
$ret->_modified[] = $key;
|
|
}
|
|
}
|
|
|
|
if ($deep) {
|
|
foreach ($this->_references as $key => $value) {
|
|
if ($value instanceof Doctrine_Collection) {
|
|
foreach ($value as $record) {
|
|
$ret->{$key}[] = $record->copy($deep);
|
|
}
|
|
} else {
|
|
$ret->set($key, $value->copy($deep));
|
|
}
|
|
}
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* assignIdentifier
|
|
*
|
|
* @param integer $id
|
|
* @return void
|
|
* @todo Not sure this is the right place here.
|
|
*/
|
|
public function assignIdentifier($id = false)
|
|
{
|
|
if ($id === false) {
|
|
$this->_id = array();
|
|
$this->_data = $this->cleanData($this->_data);
|
|
$this->_state = Doctrine_Entity::STATE_TCLEAN;
|
|
$this->_modified = array();
|
|
} else if ($id === true) {
|
|
$this->_extractIdentifier(true);
|
|
$this->_state = Doctrine_Entity::STATE_CLEAN;
|
|
$this->_modified = array();
|
|
} else {
|
|
if (is_array($id)) {
|
|
foreach ($id as $fieldName => $value) {
|
|
$this->_id[$fieldName] = $value;
|
|
$this->_data[$fieldName] = $value;
|
|
}
|
|
} else {
|
|
$idFieldNames = $this->_class->getIdentifier();
|
|
$name = $idFieldNames[0];
|
|
$this->_id[$name] = $id;
|
|
$this->_data[$name] = $id;
|
|
}
|
|
$this->_state = Doctrine_Entity::STATE_CLEAN;
|
|
$this->_modified = array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* returns the primary keys of this object
|
|
*
|
|
* @return array
|
|
*/
|
|
public function identifier()
|
|
{
|
|
return $this->_id;
|
|
}
|
|
|
|
/**
|
|
* hasRefence
|
|
* @param string $name
|
|
* @return boolean
|
|
* @todo Better name? hasAssociation() ?
|
|
*/
|
|
public function hasReference($name)
|
|
{
|
|
return isset($this->_references[$name]);
|
|
}
|
|
|
|
/**
|
|
* reference
|
|
*
|
|
* @param string $name
|
|
*/
|
|
public function reference($name)
|
|
{
|
|
if (isset($this->_references[$name])) {
|
|
return $this->_references[$name];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* obtainReference
|
|
*
|
|
* @param string $name
|
|
* @throws Doctrine_Record_Exception if trying to get an unknown related component
|
|
*/
|
|
public function obtainReference($name)
|
|
{
|
|
if (isset($this->_references[$name])) {
|
|
return $this->_references[$name];
|
|
}
|
|
throw new Doctrine_Record_Exception("Unknown reference $name.");
|
|
}
|
|
|
|
/**
|
|
* getReferences
|
|
* @return array all references
|
|
*/
|
|
public function getReferences()
|
|
{
|
|
return $this->_references;
|
|
}
|
|
|
|
/**
|
|
* setRelated
|
|
*
|
|
* @param string $alias
|
|
* @param Doctrine_Access $coll
|
|
*/
|
|
final public function setRelated($alias, Doctrine_Access $coll)
|
|
{
|
|
$this->_references[$alias] = $coll;
|
|
}
|
|
|
|
/**
|
|
* loadReference
|
|
* loads a related component
|
|
*
|
|
* @throws Doctrine_Table_Exception if trying to load an unknown related component
|
|
* @param string $name
|
|
* @return void
|
|
*/
|
|
public function loadReference($name)
|
|
{
|
|
$rel = $this->_class->getRelation($name);
|
|
$this->_references[$name] = $rel->fetchRelatedFor($this);
|
|
}
|
|
|
|
/**
|
|
* call
|
|
*
|
|
* @param string|array $callback valid callback
|
|
* @param string $column column name
|
|
* @param mixed arg1 ... argN optional callback arguments
|
|
* @return Doctrine_Entity
|
|
* @todo Really needed/used? If not, remove.
|
|
* @todo ActiveRecord method. (if at all)
|
|
*/
|
|
public function call($callback, $column)
|
|
{
|
|
$args = func_get_args();
|
|
array_shift($args);
|
|
|
|
if (isset($args[0])) {
|
|
$fieldName = $args[0];
|
|
$args[0] = $this->get($fieldName);
|
|
|
|
$newvalue = call_user_func_array($callback, $args);
|
|
|
|
$this->_data[$fieldName] = $newvalue;
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* getter for node assciated with this record
|
|
*
|
|
* @return mixed if tree returns Doctrine_Node otherwise returns false
|
|
* @todo Should go to the NestedSet Behavior plugin.
|
|
*/
|
|
public function getNode()
|
|
{
|
|
if ( ! $this->_class->isTree()) {
|
|
return false;
|
|
}
|
|
|
|
if ( ! isset($this->_node)) {
|
|
$this->_node = Doctrine_Node::factory($this,
|
|
$this->getTable()->getOption('treeImpl'),
|
|
$this->getTable()->getOption('treeOptions'));
|
|
}
|
|
|
|
return $this->_node;
|
|
}
|
|
|
|
/**
|
|
* revert
|
|
* reverts this record to given version, this method only works if versioning plugin
|
|
* is enabled
|
|
*
|
|
* @throws Doctrine_Record_Exception if given version does not exist
|
|
* @param integer $version an integer > 1
|
|
* @return Doctrine_Entity this object
|
|
* @todo Should go to the Versionable plugin.
|
|
*/
|
|
public function revert($version)
|
|
{
|
|
$data = $this->_class
|
|
->getBehavior('Doctrine_Template_Versionable')
|
|
->getAuditLog()
|
|
->getVersion($this, $version);
|
|
|
|
if ( ! isset($data[0])) {
|
|
throw new Doctrine_Record_Exception('Version ' . $version . ' does not exist!');
|
|
}
|
|
|
|
$this->_data = $data[0];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @todo get rid of filters. at least the way they're implemented atm.
|
|
*/
|
|
public function unshiftFilter(Doctrine_Record_Filter $filter)
|
|
{
|
|
return $this->_class->unshiftFilter($filter);
|
|
}
|
|
|
|
/**
|
|
* unlink
|
|
* removes links from this record to given records
|
|
* if no ids are given, it removes all links
|
|
*
|
|
* @param string $alias related component alias
|
|
* @param array $ids the identifiers of the related records
|
|
* @return Doctrine_Entity this object
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function unlink($alias, $ids = array())
|
|
{
|
|
$ids = (array) $ids;
|
|
|
|
$q = new Doctrine_Query();
|
|
|
|
$rel = $this->getTable()->getRelation($alias);
|
|
|
|
if ($rel instanceof Doctrine_Relation_Association) {
|
|
$q->delete()
|
|
->from($rel->getAssociationTable()->getComponentName())
|
|
->where($rel->getLocal() . ' = ?', array_values($this->identifier()));
|
|
|
|
if (count($ids) > 0) {
|
|
$q->whereIn($rel->getForeign(), $ids);
|
|
}
|
|
|
|
$q->execute();
|
|
|
|
} else if ($rel instanceof Doctrine_Relation_ForeignKey) {
|
|
$q->update($rel->getTable()->getComponentName())
|
|
->set($rel->getForeign(), '?', array(null))
|
|
->addWhere($rel->getForeign() . ' = ?', array_values($this->identifier()));
|
|
|
|
if (count($ids) > 0) {
|
|
$relTableIdFieldNames = (array)$rel->getTable()->getIdentifier();
|
|
$q->whereIn($relTableIdFieldNames[0], $ids);
|
|
}
|
|
|
|
$q->execute();
|
|
}
|
|
if (isset($this->_references[$alias])) {
|
|
foreach ($this->_references[$alias] as $k => $record) {
|
|
|
|
if (in_array(current($record->identifier()), $ids)) {
|
|
$this->_references[$alias]->remove($k);
|
|
}
|
|
|
|
}
|
|
|
|
$this->_references[$alias]->takeSnapshot();
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* link
|
|
* creates links from this record to given records
|
|
*
|
|
* @param string $alias related component alias
|
|
* @param array $ids the identifiers of the related records
|
|
* @return Doctrine_Entity this object
|
|
* @todo ActiveRecord method.
|
|
*/
|
|
public function link($alias, array $ids)
|
|
{
|
|
if ( ! count($ids)) {
|
|
return $this;
|
|
}
|
|
|
|
$identifier = array_values($this->identifier());
|
|
$identifier = array_shift($identifier);
|
|
|
|
$rel = $this->getTable()->getRelation($alias);
|
|
|
|
if ($rel instanceof Doctrine_Relation_Association) {
|
|
$modelClassName = $rel->getAssociationTable()->getComponentName();
|
|
$localFieldName = $rel->getLocalFieldName();
|
|
$localFieldDef = $rel->getAssociationTable()->getColumnDefinition($localFieldName);
|
|
if ($localFieldDef['type'] == 'integer') {
|
|
$identifier = (integer) $identifier;
|
|
}
|
|
$foreignFieldName = $rel->getForeignFieldName();
|
|
$foreignFieldDef = $rel->getAssociationTable()->getColumnDefinition($foreignFieldName);
|
|
if ($foreignFieldDef['type'] == 'integer') {
|
|
for ($i = 0; $i < count($ids); $i++) {
|
|
$ids[$i] = (integer) $ids[$i];
|
|
}
|
|
}
|
|
foreach ($ids as $id) {
|
|
$record = new $modelClassName;
|
|
$record[$localFieldName] = $identifier;
|
|
$record[$foreignFieldName] = $id;
|
|
$record->save();
|
|
}
|
|
|
|
} else if ($rel instanceof Doctrine_Relation_ForeignKey) {
|
|
|
|
$q = new Doctrine_Query();
|
|
|
|
$q->update($rel->getTable()->getComponentName())
|
|
->set($rel->getForeign(), '?', array_values($this->identifier()));
|
|
|
|
if (count($ids) > 0) {
|
|
$relTableIdFieldNames = (array)$rel->getTable()->getIdentifier();
|
|
$q->whereIn($relTableIdFieldNames[0], $ids);
|
|
}
|
|
|
|
$q->execute();
|
|
|
|
} else if ($rel instanceof Doctrine_Relation_LocalKey) {
|
|
|
|
$q = new Doctrine_Query();
|
|
|
|
$q->update($this->getTable()->getComponentName())
|
|
->set($rel->getLocalFieldName(), '?', $ids);
|
|
|
|
if (count($ids) > 0) {
|
|
$relTableIdFieldNames = (array)$rel->getTable()->getIdentifier();
|
|
$q->whereIn($relTableIdFieldNames[0], array_values($this->identifier()));
|
|
}
|
|
|
|
$q->execute();
|
|
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* __call
|
|
* this method is a magic method that is being used for method overloading
|
|
*
|
|
* the function of this method is to try to find given method from the templates
|
|
* this record is using and if it finds given method it will execute it
|
|
*
|
|
* So, in sense, this method replicates the usage of mixins (as seen in some programming languages)
|
|
*
|
|
* @param string $method name of the method
|
|
* @param array $args method arguments
|
|
* @return mixed the return value of the given method
|
|
* @todo In order to avoid name clashes and provide a more robust implementation
|
|
* we decided that all behaviors should be accessed through getBehavior($name)
|
|
* before they're used.
|
|
*/
|
|
public function __call($method, $args)
|
|
{
|
|
if (($behavior = $this->_class->getBehaviorForMethod($method)) !== false) {
|
|
$behavior->setInvoker($this);
|
|
return call_user_func_array(array($behavior, $method), $args);
|
|
}
|
|
|
|
foreach ($this->_class->getBehaviors() as $behavior) {
|
|
if (method_exists($behavior, $method)) {
|
|
$behavior->setInvoker($this);
|
|
$this->_class->addBehaviorMethod($method, $behavior);
|
|
return call_user_func_array(array($behavior, $method), $args);
|
|
}
|
|
}
|
|
|
|
throw new Doctrine_Record_Exception(sprintf('Unknown method %s::%s', get_class($this), $method));
|
|
}
|
|
|
|
/**
|
|
* used to delete node from tree - MUST BE USE TO DELETE RECORD IF TABLE ACTS AS TREE
|
|
*
|
|
* @todo Should go to the NestedSet Behavior plugin.
|
|
*/
|
|
public function deleteNode()
|
|
{
|
|
$this->getNode()->delete();
|
|
}
|
|
|
|
/**
|
|
* getTable
|
|
* returns the table object for this record
|
|
*
|
|
* @return Doctrine_Table a Doctrine_Table object
|
|
* @deprecated
|
|
*/
|
|
public function getTable()
|
|
{
|
|
return $this->getClassMetadata();
|
|
}
|
|
|
|
/**
|
|
* Gets the ClassMetadata object that describes the entity class.
|
|
*/
|
|
public function getClassMetadata()
|
|
{
|
|
return $this->_class;
|
|
}
|
|
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @return unknown
|
|
*/
|
|
public function getEntityManager()
|
|
{
|
|
if ( ! $this->_em) {
|
|
$this->_em = Doctrine_EntityManager::getManager($this->_entityName);
|
|
}
|
|
return $this->_em;
|
|
}
|
|
|
|
public function getRepository()
|
|
{
|
|
return $this->_class->getConnection()->getRepository($this->_entityName);
|
|
}
|
|
|
|
/**
|
|
* @todo Why toString() and __toString() ?
|
|
*/
|
|
public function toString()
|
|
{
|
|
return Doctrine::dump(get_object_vars($this));
|
|
}
|
|
|
|
/**
|
|
* returns a string representation of this object
|
|
* @todo Why toString() and __toString() ?
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return (string) $this->_oid;
|
|
}
|
|
|
|
/**
|
|
* Helps freeing the memory occupied by the entity.
|
|
* Cuts all references the entity has to other entities and removes the entity
|
|
* from the instance pool.
|
|
* Note: The entity is no longer useable after free() has been called. Any operations
|
|
* done with the entity afterwards can lead to unpredictable results.
|
|
*/
|
|
public function free($deep = false)
|
|
{
|
|
if ($this->_state != self::STATE_LOCKED) {
|
|
$this->_em->detach($this);
|
|
$this->_data = array();
|
|
$this->_id = array();
|
|
|
|
if ($deep) {
|
|
foreach ($this->_references as $name => $reference) {
|
|
if ( ! ($reference instanceof Doctrine_Null)) {
|
|
$reference->free($deep);
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->_references = array();
|
|
}
|
|
}
|
|
|
|
}
|