first commit

typo3/sysext/extbase/Classes/DomainObject/AbstractDomainObject.php

@@ -0,0 +1,345 @@
+<?php
+namespace TYPO3\CMS\Extbase\DomainObject;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+use TYPO3\CMS\Extbase\Persistence\Generic\LazyLoadingProxy;
+
+/**
+ * A generic Domain Object.
+ *
+ * All Model domain objects need to inherit from either AbstractEntity or AbstractValueObject, as this provides important framework information.
+ * @internal only to be used within Extbase, not part of TYPO3 Core API.
+ */
+abstract class AbstractDomainObject implements DomainObjectInterface, \TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface
+{
+    /**
+     * @var int The uid of the record. The uid is only unique in the context of the database table.
+     */
+    protected $uid;
+
+    /**
+     * @var int The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).
+     */
+    protected $_localizedUid;
+
+    /**
+     * @var int The uid of the language of the object. This is the uid of the language record in the table sys_language.
+     */
+    protected $_languageUid;
+
+    /**
+     * @var int The uid of the versioned record.
+     */
+    protected $_versionedUid;
+
+    /**
+     * @var int The id of the page the record is "stored".
+     */
+    protected $pid;
+
+    /**
+     * TRUE if the object is a clone
+     *
+     * @var bool
+     */
+    private $_isClone = false;
+
+    /**
+     * @var array An array holding the clean property values. Set right after reconstitution of the object
+     */
+    private $_cleanProperties = [];
+
+    /**
+     * Getter for uid.
+     *
+     * @return int the uid or NULL if none set yet.
+     */
+    public function getUid()
+    {
+        if ($this->uid !== null) {
+            return (int)$this->uid;
+        }
+        return null;
+    }
+
+    /**
+     * Setter for the pid.
+     *
+     * @param int|null $pid
+     */
+    public function setPid($pid)
+    {
+        if ($pid === null) {
+            $this->pid = null;
+        } else {
+            $this->pid = (int)$pid;
+        }
+    }
+
+    /**
+     * Getter for the pid.
+     *
+     * @return int The pid or NULL if none set yet.
+     */
+    public function getPid()
+    {
+        if ($this->pid === null) {
+            return null;
+        }
+        return (int)$this->pid;
+    }
+
+    /**
+     * Reconstitutes a property. Only for internal use.
+     *
+     * @param string $propertyName
+     * @param mixed $propertyValue
+     * @return bool
+     */
+    public function _setProperty($propertyName, $propertyValue)
+    {
+        if ($this->_hasProperty($propertyName)) {
+            $this->{$propertyName} = $propertyValue;
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Returns the property value of the given property name. Only for internal use.
+     *
+     * @param string $propertyName
+     * @return mixed The propertyValue
+     */
+    public function _getProperty($propertyName)
+    {
+        return $this->{$propertyName};
+    }
+
+    /**
+     * Returns a hash map of property names and property values. Only for internal use.
+     *
+     * @return array The properties
+     */
+    public function _getProperties()
+    {
+        $properties = get_object_vars($this);
+        foreach ($properties as $propertyName => $propertyValue) {
+            if ($propertyName[0] === '_') {
+                unset($properties[$propertyName]);
+            }
+        }
+        return $properties;
+    }
+
+    /**
+     * Returns the property value of the given property name. Only for internal use.
+     *
+     * @param string $propertyName
+     * @return bool TRUE bool true if the property exists, FALSE if it doesn't exist or NULL in case of an error.
+     */
+    public function _hasProperty($propertyName)
+    {
+        return property_exists($this, $propertyName);
+    }
+
+    /**
+     * Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
+     *
+     * @return bool
+     */
+    public function _isNew()
+    {
+        return $this->uid === null;
+    }
+
+    /**
+     * Register an object's clean state, e.g. after it has been reconstituted
+     * from the database.
+     *
+     * @param string $propertyName The name of the property to be memorized. If omitted all persistable properties are memorized.
+     */
+    public function _memorizeCleanState($propertyName = null)
+    {
+        if ($propertyName !== null) {
+            $this->_memorizePropertyCleanState($propertyName);
+        } else {
+            $this->_cleanProperties = [];
+            $properties = get_object_vars($this);
+            foreach ($properties as $propertyName => $propertyValue) {
+                if ($propertyName[0] === '_') {
+                    continue;
+                }
+                // Do not memorize "internal" properties
+                $this->_memorizePropertyCleanState($propertyName);
+            }
+        }
+    }
+
+    /**
+     * Register an properties's clean state, e.g. after it has been reconstituted
+     * from the database.
+     *
+     * @param string $propertyName The name of the property to be memorized. If omittet all persistable properties are memorized.
+     */
+    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;
+        }
+    }
+
+    /**
+     * Returns a hash map of clean properties and $values.
+     *
+     * @return array
+     */
+    public function _getCleanProperties()
+    {
+        return $this->_cleanProperties;
+    }
+
+    /**
+     * Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or
+     * if the clean value is NULL.
+     *
+     * @param string $propertyName The name of the property to be memorized.
+     * @return mixed The clean property value or NULL
+     */
+    public function _getCleanProperty($propertyName)
+    {
+        return $this->_cleanProperties[$propertyName] ?? null;
+    }
+
+    /**
+     * Returns TRUE if the properties were modified after reconstitution
+     *
+     * @param string $propertyName An optional name of a property to be checked if its value is dirty
+     * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\TooDirtyException
+     * @return bool
+     */
+    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;
+    }
+
+    /**
+     * Checks the $value against the $cleanState.
+     *
+     * @param mixed $previousValue
+     * @param mixed $currentValue
+     * @return bool
+     */
+    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)) {
+            $currentTypeString = null;
+            if ($currentValue instanceof LazyLoadingProxy) {
+                $currentTypeString = $currentValue->_getTypeAndUidString();
+            } elseif ($currentValue instanceof DomainObjectInterface) {
+                $currentTypeString = get_class($currentValue) . ':' . $currentValue->getUid();
+            }
+
+            if ($currentTypeString !== null) {
+                $previousTypeString = null;
+                if ($previousValue instanceof LazyLoadingProxy) {
+                    $previousTypeString = $previousValue->_getTypeAndUidString();
+                } elseif ($previousValue instanceof DomainObjectInterface) {
+                    $previousTypeString = get_class($previousValue) . ':' . $previousValue->getUid();
+                }
+
+                $result = $currentTypeString !== $previousTypeString;
+            } 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;
+    }
+
+    /**
+     * Returns TRUE if the object has been clonesd, cloned, FALSE otherwise.
+     *
+     * @return bool TRUE if the object has been cloned
+     */
+    public function _isClone()
+    {
+        return $this->_isClone;
+    }
+
+    /**
+     * Setter whether this Domain Object is a clone of another one.
+     * NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the
+     * _isDirty check inside AbstractEntity work, but it is just a work-
+     * around right now.
+     *
+     * @param bool $clone
+     */
+    public function _setClone($clone)
+    {
+        $this->_isClone = (bool)$clone;
+    }
+
+    /**
+     * Clone method. Sets the _isClone property.
+     */
+    public function __clone()
+    {
+        $this->_isClone = true;
+    }
+
+    /**
+     * Returns the class name and the uid of the object as string
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return static::class . ':' . (string)$this->uid;
+    }
+}

typo3/sysext/extbase/Classes/DomainObject/AbstractEntity.php

@@ -0,0 +1,23 @@
+<?php
+namespace TYPO3\CMS\Extbase\DomainObject;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * An abstract Entity. An Entity is an object fundamentally defined not by its attributes,
+ * but by a thread of continuity and identity (e.g. a person).
+ */
+abstract class AbstractEntity extends \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
+{
+}

typo3/sysext/extbase/Classes/DomainObject/AbstractValueObject.php

@@ -0,0 +1,33 @@
+<?php
+namespace TYPO3\CMS\Extbase\DomainObject;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * An abstract Value Object. A Value Object is an object that describes some characteristic
+ * or attribute (e.g. a color) but carries no concept of identity.
+ * @internal only to be used within Extbase, not part of TYPO3 Core API.
+ */
+abstract class AbstractValueObject extends \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject
+{
+    /**
+     * Returns the value of the Value Object. Must be overwritten by a concrete value object.
+     *
+     * @return string
+     */
+    public function getValue()
+    {
+        return $this->__toString();
+    }
+}

typo3/sysext/extbase/Classes/DomainObject/DomainObjectInterface.php

@@ -0,0 +1,86 @@
+<?php
+namespace TYPO3\CMS\Extbase\DomainObject;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * A Domain Object Interface. All domain objects which should be persisted need to implement the below interface.
+ * Usually you will need to subclass \TYPO3\CMS\Extbase\DomainObject\AbstractEntity and \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject
+ * instead.
+ *
+ * @see \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
+ * @see \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject
+ */
+interface DomainObjectInterface
+{
+    /**
+     * Getter for uid.
+     *
+     * @return int The uid or NULL if none set yet.
+     */
+    public function getUid();
+
+    /**
+     * Setter for the pid.
+     *
+     * @param int $pid
+     */
+    public function setPid($pid);
+
+    /**
+     * Getter for the pid.
+     *
+     * @return int The pid or NULL if none set yet.
+     */
+    public function getPid();
+
+    /**
+     * Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
+     *
+     * @return bool
+     */
+    public function _isNew();
+
+    /**
+     * Reconstitutes a property. Only for internal use.
+     *
+     * @param string $propertyName
+     * @param string $value
+     */
+    public function _setProperty($propertyName, $value);
+
+    /**
+     * Returns the property value of the given property name. Only for internal use.
+     *
+     * @param string $propertyName
+     * @return mixed The propertyValue
+     */
+    public function _getProperty($propertyName);
+
+    /**
+     * Returns a hash map of property names and property values
+     *
+     * @return array The properties
+     */
+    public function _getProperties();
+
+    /**
+     * Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or
+     * if the clean value is NULL.
+     *
+     * @param string $propertyName The name of the property to be memorized.
+     * @return mixed The clean property value or NULL
+     */
+    public function _getCleanProperty($propertyName);
+}