AbstractDomainObject.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Extbase\DomainObject;
 
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Exception\TooDirtyException;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\LazyLoadingProxy;
use ‪TYPO3\CMS\Extbase\Persistence\ObjectMonitoringInterface;
 
abstract class ‪AbstractDomainObject implements ‪DomainObjectInterface
{
    public const ‪PROPERTY_UID = 'uid';
    public const ‪PROPERTY_PID = 'pid';
    public const ‪PROPERTY_LOCALIZED_UID = '_localizedUid';
    public const ‪PROPERTY_LANGUAGE_UID = '_languageUid';
    public const ‪PROPERTY_VERSIONED_UID = '_versionedUid';
 
    protected ?int ‪$uid = null;
 
    protected ?int ‪$_localizedUid = null;
 
    protected ?int ‪$_languageUid = null;
 
    protected ?int ‪$_versionedUid = null;
 
    protected ?int ‪$pid = null;
 
    private bool ‪$_isClone = false;
 
    private array ‪$_cleanProperties = [];
 
    public function ‪getUid(): ?int
    {
        if ($this->‪uid !== null) {
            return (int)‪$this->uid;
        }
        return null;
    }
 
    public function ‪setPid(int $pid): void
    {
        $this->‪pid = ‪$pid;
    }
 
    public function ‪getPid(): int|‪null
    {
        if ($this->‪pid === null) {
            return null;
        }
        return (int)‪$this->pid;
    }
 
    public function ‪_setProperty(string $propertyName, mixed $value): bool
    {
        if ($this->‪_hasProperty($propertyName)) {
            $this->{$propertyName} = $value;
            return true;
        }
        return false;
    }
 
    public function ‪_getProperty(string $propertyName): mixed
    {
        return $this->‪_hasProperty($propertyName) && isset($this->{$propertyName})
            ? $this->{$propertyName}
            : null;
    }
 
    public function _getProperties(): array
    {
        $properties = get_object_vars($this);
        foreach ($properties as $propertyName => $propertyValue) {
            if (str_starts_with($propertyName, '_')) {
                unset($properties[$propertyName]);
            }
        }
        return $properties;
    }
 
    public function ‪_hasProperty(string $propertyName): bool
    {
        return property_exists($this, $propertyName);
    }
 
    public function ‪_isNew(): bool
    {
        return $this->‪uid === null;
    }
 
    public function ‪_memorizeCleanState(?string $propertyName = null): void
    {
        if ($propertyName !== null) {
            $this->‪_memorizePropertyCleanState($propertyName);
        } else {
            $this->‪_cleanProperties = [];
            foreach ($this->_getProperties() as $propertyName => $propertyValue) {
                $this->‪_memorizePropertyCleanState($propertyName);
            }
        }
    }
 
    public function ‪_memorizePropertyCleanState(string $propertyName): void
    {
        $propertyValue = $this->‪_getProperty($propertyName);
        if (is_object($propertyValue) && !($propertyValue instanceof \UnitEnum)) {
            $propertyValueClone = 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 ($propertyValueClone instanceof ‪AbstractDomainObject) {
                $propertyValueClone->_setClone(false);
            }
 
            $this->‪_cleanProperties[$propertyName] = $propertyValueClone;
        } else {
            $this->‪_cleanProperties[$propertyName] = $propertyValue;
        }
    }
 
    public function _getCleanProperties(): array
    {
        return ‪$this->_cleanProperties;
    }
 
    public function ‪_getCleanProperty(string $propertyName): mixed
    {
        return $this->‪_cleanProperties[$propertyName] ?? null;
    }
 
    public function ‪_isDirty(?string $propertyName = null): bool
    {
        if ($this->‪uid !== null && $this->‪_getCleanProperty(self::PROPERTY_UID) !== null && $this->‪uid != $this->‪_getCleanProperty(self::PROPERTY_UID)) {
            throw new ‪TooDirtyException('The ' . self::PROPERTY_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->‪_getProperty($propertyName)) === true) {
                    return true;
                }
            }
            return false;
        }
 
        if ($this->‪isPropertyDirty($this->‪_getCleanProperty($propertyName), $this->‪_getProperty($propertyName)) === true) {
            return true;
        }
 
        return false;
    }
 
    protected function ‪isPropertyDirty(mixed $previousValue, mixed $currentValue): bool
    {
        // 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 = $currentValue::class . ':' . $currentValue->getUid();
            }
 
            if ($currentTypeString !== null) {
                $previousTypeString = null;
                if ($previousValue instanceof ‪LazyLoadingProxy) {
                    $previousTypeString = $previousValue->_getTypeAndUidString();
                } elseif ($previousValue instanceof ‪DomainObjectInterface) {
                    $previousTypeString = $previousValue::class . ':' . $previousValue->getUid();
                }
 
                $result = $currentTypeString !== $previousTypeString;
            } elseif ($currentValue instanceof ‪ObjectMonitoringInterface) {
                $result = !is_object($previousValue) || $currentValue->_isDirty() || $previousValue::class !== $currentValue::class;
            } 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(): bool
    {
        return ‪$this->_isClone;
    }
 
    public function ‪_setClone(bool $clone)
    {
        $this->‪_isClone = $clone;
    }
 
    public function ‪__clone(): void
    {
        $this->‪_isClone = true;
    }
 
    public function ‪__toString(): string
    {
        return static::class . ':' . ‪$this->uid;
    }
}