9.5/_abstract_domain_object_8php_source.html

<?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;


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 = [];


    public function ‪getUid()

    {

        if ($this->uid !== null) {

            return (int)‪$this->uid;

        }

        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;

        }

        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 = [];

            $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 $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)) {

            $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;

    }


    public function ‪_isClone()

    {

        return ‪$this->_isClone;

    }


    public function ‪_setClone($clone)

    {

        $this->‪_isClone = (bool)$clone;

    }


    public function ‪__clone()

    {

        $this->‪_isClone = true;

    }


    public function ‪__toString()

    {

        return static::class . ':' . (string)$this->uid;

    }

}