DependencyResolver.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\Workspaces\Dependency;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪DependencyResolver
{
    protected int ‪$workspace = 0;
    protected ?‪DependencyEntityFactory ‪$factory;
    protected array ‪$elements = [];
    protected array ‪$eventCallbacks = [];
    protected bool ‪$outerMostParentsRequireReferences = false;
    protected ?array ‪$outerMostParents;
 
    public function ‪setWorkspace(int ‪$workspace): void
    {
        $this->workspace = ‪$workspace;
    }
 
    public function ‪getWorkspace(): int
    {
        return ‪$this->workspace;
    }
 
    public function ‪setEventCallback(string $eventName, ‪EventCallback $callback): self
    {
        $this->eventCallbacks[$eventName] = $callback;
        return $this;
    }
 
    public function ‪executeEventCallback(string $eventName, object $caller, array $callerArguments = []): mixed
    {
        if (isset($this->eventCallbacks[$eventName])) {
            $callback = $this->eventCallbacks[$eventName];
            return $callback->execute($callerArguments, $caller, $eventName);
        }
        return null;
    }
 
    public function ‪setOuterMostParentsRequireReferences(bool ‪$outerMostParentsRequireReferences): self
    {
        $this->outerMostParentsRequireReferences = (bool)‪$outerMostParentsRequireReferences;
        return $this;
    }
 
    public function ‪addElement(string $table, int $id, array $data = []): ‪ElementEntity
    {
        $element = $this->‪getFactory()->getElement($table, $id, $data, $this);
        $elementName = $element->__toString();
        $this->elements[$elementName] = $element;
        return $element;
    }
 
    public function ‪getOuterMostParents(): array
    {
        if (!isset($this->outerMostParents)) {
            $this->outerMostParents = [];
            foreach ($this->elements as $element) {
                $this->‪processOuterMostParent($element);
            }
        }
        return ‪$this->outerMostParents;
    }
 
    protected function ‪processOuterMostParent(‪ElementEntity $element): void
    {
        if ($this->outerMostParentsRequireReferences === false || $element->‪hasReferences()) {
            $outerMostParent = $element->‪getOuterMostParent();
            if ($outerMostParent !== false) {
                $outerMostParentName = $outerMostParent->__toString();
                if (!isset($this->outerMostParents[$outerMostParentName])) {
                    $this->outerMostParents[$outerMostParentName] = $outerMostParent;
                }
            }
        }
    }
 
    public function ‪getNestedElements(‪ElementEntity $outerMostParent): array
    {
        $outerMostParentName = $outerMostParent->‪__toString();
        if (!isset($this->outerMostParents[$outerMostParentName])) {
            throw new \RuntimeException('Element "' . $outerMostParentName . '" was not detected as outermost parent.', 1289318609);
        }
        $nestedStructure = array_merge([$outerMostParentName => $outerMostParent], $outerMostParent->‪getNestedChildren());
        return $nestedStructure;
    }
 
    public function ‪getElements(): array
    {
        return ‪$this->elements;
    }
 
    public function ‪getFactory(): ‪DependencyEntityFactory
    {
        if (!isset($this->factory)) {
            $this->factory = GeneralUtility::makeInstance(DependencyEntityFactory::class);
        }
        return ‪$this->factory;
    }
}