AbstractDomainObject.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\DomainObject;

abstract class AbstractDomainObject implements DomainObjectInterface, \TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface {

    protected $uid;

    protected $_localizedUid;

    protected $_languageUid;

    protected $_versionedUid;

    protected $pid;

    private $_isClone = FALSE;

    private $_cleanProperties = array();

    public function __wakeup() {
    }

    public function initializeObject() {
    }

    public function getUid() {
        if ($this->uid !== NULL) {
            return (int)$this->uid;
        } else {
            return NULL;
        }
    }

    public function setPid($pid) {
        if ($pid === NULL) {
            $this->pid = NULL;
        } else {
            $this->pid = (int)$pid;
        }
    }

    public function getPid() {
        if ($this->pid === NULL) {
            return NULL;
        } else {
            return (int)$this->pid;
        }
    }

    public function _setProperty($propertyName, $propertyValue) {
        if ($this->_hasProperty($propertyName)) {
            $this->{$propertyName} = $propertyValue;
            return TRUE;
        }
        return FALSE;
    }

    public function _getProperty($propertyName) {
        return $this->{$propertyName};
    }

    public function _getProperties() {
        $properties = get_object_vars($this);
        foreach ($properties as $propertyName => $propertyValue) {
            if ($propertyName[0] === '_') {
                unset($properties[$propertyName]);
            }
        }
        return $properties;
    }

    public function _hasProperty($propertyName) {
        return property_exists($this, $propertyName);
    }

    public function _isNew() {
        return $this->uid === NULL;
    }

    public function _memorizeCleanState($propertyName = NULL) {
        if ($propertyName !== NULL) {
            $this->_memorizePropertyCleanState($propertyName);
        } else {
            $this->_cleanProperties = array();
            $properties = get_object_vars($this);
            foreach ($properties as $propertyName => $propertyValue) {
                if ($propertyName[0] === '_') {
                    continue;
                }
                // Do not memorize "internal" properties
                $this->_memorizePropertyCleanState($propertyName);
            }
        }
    }

    public function _memorizePropertyCleanState($propertyName) {
        $propertyValue = $this->{$propertyName};
        if (is_object($propertyValue)) {
            $this->_cleanProperties[$propertyName] = clone $propertyValue;
            // We need to make sure the clone and the original object
            // are identical when compared with == (see _isDirty()).
            // After the cloning, the Domain Object will have the property
            // "isClone" set to TRUE, so we manually have to set it to FALSE
            // again. Possible fix: Somehow get rid of the "isClone" property,
            // which is currently needed in Fluid.
            if ($propertyValue instanceof \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject) {
                $this->_cleanProperties[$propertyName]->_setClone(FALSE);
            }
        } else {
            $this->_cleanProperties[$propertyName] = $propertyValue;
        }
    }

    public function _getCleanProperties() {
        return $this->_cleanProperties;
    }

    public function _getCleanProperty($propertyName) {
        return isset($this->_cleanProperties[$propertyName]) ? $this->_cleanProperties[$propertyName] : NULL;
    }

    public function _isDirty($propertyName = NULL) {
        if ($this->uid !== NULL && $this->_getCleanProperty('uid') !== NULL && $this->uid != $this->_getCleanProperty('uid')) {
            throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\TooDirtyException('The uid "' . $this->uid . '" has been modified, that is simply too much.', 1222871239);
        }

        if ($propertyName === NULL) {
            foreach ($this->_getCleanProperties() as $propertyName => $cleanPropertyValue) {
                if ($this->isPropertyDirty($cleanPropertyValue, $this->{$propertyName}) === TRUE) {
                    return TRUE;
                }
            }
        } else {
            if ($this->isPropertyDirty($this->_getCleanProperty($propertyName), $this->{$propertyName}) === TRUE) {
                return TRUE;
            }
        }
        return FALSE;
    }

    protected function isPropertyDirty($previousValue, $currentValue) {
        // In case it is an object and it implements the ObjectMonitoringInterface, we call _isDirty() instead of a simple comparison of objects.
        // We do this, because if the object itself contains a lazy loaded property, the comparison of the objects might fail even if the object didn't change
        if (is_object($currentValue)) {
            if ($currentValue instanceof DomainObjectInterface) {
                $result = !is_object($previousValue) || get_class($previousValue) !== get_class($currentValue) || $currentValue->getUid() !== $previousValue->getUid();
            } elseif ($currentValue instanceof \TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface) {
                $result = !is_object($previousValue) || $currentValue->_isDirty() || get_class($previousValue) !== get_class($currentValue);
            } else {
                // For all other objects we do only a simple comparison (!=) as we want cloned objects to return the same values.
                $result = $previousValue != $currentValue;
            }
        } else {
            $result = $previousValue !== $currentValue;
        }
        return $result;
    }

    public function _isClone() {
        return $this->_isClone;
    }

    public function _setClone($clone) {
        $this->_isClone = (boolean) $clone;
    }

    public function __clone() {
        $this->_isClone = TRUE;
    }

    public function __toString() {
        return get_class($this) . ':' . (string) $this->uid;
    }
}