9.5/_collection_service_8php_source.html

<?php

namespace ‪TYPO3\CMS\Workspaces\Service\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!

 */


use ‪TYPO3\CMS\Core\SingletonInterface;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Workspaces\Dependency;

use ‪TYPO3\CMS\Workspaces\Service\GridDataService;


class ‪CollectionService implements ‪SingletonInterface

{

    protected ‪$dataHandler;


    protected ‪$elementEntityProcessor;


    protected ‪$dependencyResolver;


    protected ‪$dataArray;


    protected ‪$nestedDataArray;


    public function ‪getDependencyResolver()

    {

        if (!isset($this->dependencyResolver)) {

            $this->dependencyResolver = GeneralUtility::makeInstance(Dependency\DependencyResolver::class);

            $this->dependencyResolver->setOuterMostParentsRequireReferences(true);

            $this->dependencyResolver->setWorkspace($this->‪getWorkspace());


            $this->dependencyResolver->setEventCallback(

                Dependency\‪ElementEntity::EVENT_Construct,

                $this->‪getDependencyCallback('createNewDependentElementCallback')

            );


            $this->dependencyResolver->setEventCallback(

                Dependency\‪ElementEntity::EVENT_CreateChildReference,

                $this->‪getDependencyCallback('createNewDependentElementChildReferenceCallback')

            );


            $this->dependencyResolver->setEventCallback(

                Dependency\‪ElementEntity::EVENT_CreateParentReference,

                $this->‪getDependencyCallback('createNewDependentElementParentReferenceCallback')

            );

        }


        return ‪$this->dependencyResolver;

    }


    protected function ‪getDependencyCallback($method, array $targetArguments = [])

    {

        return GeneralUtility::makeInstance(

            Dependency\EventCallback::class,

            $this->‪getElementEntityProcessor(),

            $method,

            $targetArguments

        );

    }


    protected function ‪getElementEntityProcessor()

    {

        if (!isset($this->elementEntityProcessor)) {

            $this->elementEntityProcessor = GeneralUtility::makeInstance(Dependency\ElementEntityProcessor::class);

            $this->elementEntityProcessor->setWorkspace($this->‪getWorkspace());

        }

        return ‪$this->elementEntityProcessor;

    }


    protected function ‪getWorkspace()

    {

        return (int)‪$GLOBALS['BE_USER']->workspace;

    }


    public function ‪process(array ‪$dataArray)

    {

        $collection = 0;

        $this->dataArray = ‪$dataArray;

        $this->nestedDataArray = [];


        $outerMostParents = $this->‪getDependencyResolver()->‪getOuterMostParents();


        if (empty($outerMostParents)) {

            return ‪$this->dataArray;

        }


        // For each outer most parent, get all nested child elements:

        foreach ($outerMostParents as $outerMostParent) {

            $this->‪resolveDataArrayChildDependencies(

                $outerMostParent,

                ++$collection

            );

        }


        $processedDataArray = $this->‪finalize($this->dataArray);


        unset($this->dataArray);

        unset($this->nestedDataArray);


        return $processedDataArray;

    }


    protected function ‪finalize(array ‪$dataArray)

    {

        $processedDataArray = [];

        foreach (‪$dataArray as $dataElement) {

            $dataElementIdentifier = $dataElement['id'];

            $processedDataArray[] = $dataElement;

            // Insert children (if any)

            if (!empty($this->nestedDataArray[$dataElementIdentifier])) {

                $processedDataArray = array_merge(

                    $processedDataArray,

                    $this->‪finalize($this->nestedDataArray[$dataElementIdentifier])

                );

                unset($this->nestedDataArray[$dataElementIdentifier]);

            }

        }


        return $processedDataArray;

    }


    protected function ‪resolveDataArrayChildDependencies(Dependency\ElementEntity $parent, $collection, $nextParentIdentifier = '', $collectionLevel = 0)

    {

        $parentIdentifier = $parent->__toString();

        $parentIsSet = isset($this->dataArray[$parentIdentifier]);


        if ($parentIsSet) {

            $this->dataArray[$parentIdentifier][‪GridDataService::GridColumn_Collection] = $collection;

            $this->dataArray[$parentIdentifier][‪GridDataService::GridColumn_CollectionLevel] = $collectionLevel;

            $this->dataArray[$parentIdentifier][‪GridDataService::GridColumn_CollectionCurrent] = md5($parentIdentifier);

            $this->dataArray[$parentIdentifier][‪GridDataService::GridColumn_CollectionChildren] = count($parent->getChildren());

            $nextParentIdentifier = $parentIdentifier;

            $collectionLevel++;

        }


        foreach ($parent->getChildren() as $child) {

            $this->‪resolveDataArrayChildDependencies(

                $child->getElement(),

                $collection,

                $nextParentIdentifier,

                $collectionLevel

            );


            $childIdentifier = $child->getElement()->__toString();

            if (!empty($nextParentIdentifier) && isset($this->dataArray[$childIdentifier])) {

                // Remove from dataArray, but collect to process later

                // and add it just next to the accordant parent element

                $this->dataArray[$childIdentifier][‪GridDataService::GridColumn_CollectionParent] = md5($nextParentIdentifier);

                $this->nestedDataArray[$nextParentIdentifier][] = $this->dataArray[$childIdentifier];

                unset($this->dataArray[$childIdentifier]);

            }

        }

    }

}