LazyLoadingProxy.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\Persistence\Generic;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper;
 
class ‪LazyLoadingProxy implements \Iterator, ‪LoadingStrategyInterface
{
    protected ?‪DataMapper ‪$dataMapper = null;
 
    private ‪$parentObject;
 
    private ‪$propertyName;
 
    private ‪$fieldValue;
 
    public function ‪__construct(‪$parentObject, ‪$propertyName, ‪$fieldValue, ?‪DataMapper ‪$dataMapper = null)
    {
        $this->parentObject = ‪$parentObject;
        $this->propertyName = ‪$propertyName;
        $this->fieldValue = ‪$fieldValue;
        if (‪$dataMapper === null) {
            ‪$dataMapper = GeneralUtility::makeInstance(DataMapper::class);
        }
        $this->dataMapper = ‪$dataMapper;
    }
 
    public function ‪_loadRealInstance()
    {
        // this check safeguards against a proxy being activated multiple times
        // usually that does not happen, but if the proxy is held from outside
        // its parent ... the result would be weird.
        if ($this->parentObject instanceof ‪DomainObjectInterface
            && $this->parentObject->‪_getProperty($this->propertyName) instanceof ‪LazyLoadingProxy
            && $this->dataMapper
        ) {
            $objects = $this->dataMapper->fetchRelated($this->parentObject, $this->propertyName, $this->fieldValue, false);
            $propertyValue = $this->dataMapper->mapResultToPropertyValue($this->parentObject, $this->propertyName, $objects);
            $this->parentObject->_setProperty($this->propertyName, $propertyValue);
            $this->parentObject->_memorizeCleanState($this->propertyName);
            return $propertyValue;
        }
        return $this->parentObject->_getProperty($this->propertyName);
    }
 
    public function ‪_getTypeAndUidString()
    {
        $type = $this->dataMapper->getType(get_class($this->parentObject), $this->propertyName);
        return $type . ':' . ‪$this->fieldValue;
    }
 
    public function ‪getUid(): int
    {
        return (int)‪$this->fieldValue;
    }
 
    public function ‪__call($methodName, $arguments)
    {
        $realInstance = $this->‪_loadRealInstance();
        if (!is_object($realInstance)) {
            return null;
        }
        $callable = [$realInstance, $methodName];
        return $callable(...$arguments);
    }
 
    public function ‪__get(‪$propertyName)
    {
        $realInstance = $this->‪_loadRealInstance();
 
        if ($realInstance instanceof DomainObjectInterface) {
            return $realInstance->_getProperty(‪$propertyName);
        }
        return $realInstance?->{‪$propertyName};
    }
 
    public function __set($propertyName, $value)
    {
        $realInstance = $this->_loadRealInstance();
        $realInstance->{$propertyName} = $value;
    }
 
    public function __isset($propertyName)
    {
        $realInstance = $this->_loadRealInstance();
        return isset($realInstance->{$propertyName});
    }
 
    public function __unset($propertyName)
    {
        $realInstance = $this->_loadRealInstance();
        unset($realInstance->{$propertyName});
    }
 
    public function __toString()
    {
        $realInstance = $this->_loadRealInstance();
        return $realInstance->__toString();
    }
 
    public function current(): mixed
    {
        // todo: make sure current() can be performed on $realInstance
        $realInstance = $this->_loadRealInstance();
        return current($realInstance);
    }
 
    public function key(): mixed
    {
        // todo: make sure key() can be performed on $realInstance
        $realInstance = $this->_loadRealInstance();
        return key($realInstance);
    }
 
    public function next(): void
    {
        // todo: make sure next() can be performed on $realInstance
        $realInstance = $this->_loadRealInstance();
        next($realInstance);
    }
 
    public function rewind(): void
    {
        // todo: make sure reset() can be performed on $realInstance
        $realInstance = $this->_loadRealInstance();
        reset($realInstance);
    }
 
    public function valid(): bool
    {
        return $this->current() !== false;
    }
 
    public function __serialize(): array
    {
        $properties = get_object_vars($this);
        unset($properties['dataMapper']);
        return $properties;
    }
 
    public function __unserialize(array $data): void
    {
        foreach ($data as $propertyName => $propertyValue) {
            $this->{$propertyName} = $propertyValue;
        }
 
        $this->dataMapper = GeneralUtility::getContainer()->get(DataMapper::class);
    }
}