DependencyResolver.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Version\Dependency;

/*
 * 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!
 */

class DependencyResolver
{
    protected $workspace = 0;

    protected $factory;

    protected $elements = [];

    protected $eventCallbacks = [];

    protected $outerMostParentsRequireReferences = false;

    protected $outerMostParents;

    public function setWorkspace($workspace)
    {
        $this->workspace = (int)$workspace;
    }

    public function getWorkspace()
    {
        return $this->workspace;
    }

    public function setEventCallback($eventName, \TYPO3\CMS\Version\Dependency\EventCallback $callback)
    {
        $this->eventCallbacks[$eventName] = $callback;
        return $this;
    }

    public function executeEventCallback($eventName, $caller, array $callerArguments = [])
    {
        if (isset($this->eventCallbacks[$eventName])) {
            $callback = $this->eventCallbacks[$eventName];
            return $callback->execute($callerArguments, $caller, $eventName);
        }
        return null;
    }

    public function setOuterMostParentsRequireReferences($outerMostParentsRequireReferences)
    {
        $this->outerMostParentsRequireReferences = (bool)$outerMostParentsRequireReferences;
        return $this;
    }

    public function addElement($table, $id, array $data = [])
    {
        $element = $this->getFactory()->getElement($table, $id, $data, $this);
        $elementName = $element->__toString();
        $this->elements[$elementName] = $element;
        return $element;
    }

    public function getOuterMostParents()
    {
        if (!isset($this->outerMostParents)) {
            $this->outerMostParents = [];
            foreach ($this->elements as $element) {
                $this->processOuterMostParent($element);
            }
        }
        return $this->outerMostParents;
    }

    protected function processOuterMostParent(\TYPO3\CMS\Version\Dependency\ElementEntity $element)
    {
        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(\TYPO3\CMS\Version\Dependency\ElementEntity $outerMostParent)
    {
        $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()
    {
        return $this->elements;
    }

    public function getFactory()
    {
        if (!isset($this->factory)) {
            $this->factory = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Version\Dependency\DependencyEntityFactory::class);
        }
        return $this->factory;
    }
}