DataProviderCollection.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\View\BackendLayout;

class DataProviderCollection implements \TYPO3\CMS\Core\SingletonInterface {

    protected $dataProviders = array();

    protected $results = array();

    public function add($identifier, $classNameOrObject) {
        if (strpos($identifier, '__') !== FALSE) {
            throw new \UnexpectedValueException(
                'Identifier "' . $identifier . '" must not contain "__"',
                1381597629
            );
        }

        if (is_object($classNameOrObject)) {
            $className = get_class($classNameOrObject);
            $dataProvider = $classNameOrObject;
        } else {
            $className = $classNameOrObject;
            $dataProvider = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance($classNameOrObject);
        }

        if (!$dataProvider instanceof DataProviderInterface) {
            throw new \LogicException(
                $className . ' must implement interface TYPO3\\CMS\\Backend\\View\\BackendLayout\\DataProviderInterface',
                1381269811
            );
        }

        $this->dataProviders[$identifier] = $dataProvider;
    }

    public function getBackendLayoutCollections(DataProviderContext $dataProviderContext) {
        $result = array();

        foreach ($this->dataProviders as $identifier => $dataProvider) {
            $backendLayoutCollection = $this->createBackendLayoutCollection($identifier);
            $dataProvider->addBackendLayouts($dataProviderContext, $backendLayoutCollection);
            $result[$identifier] = $backendLayoutCollection;
        }

        return $result;
    }

    public function getBackendLayout($combinedIdentifier, $pageId) {
        $backendLayout = NULL;

        if (strpos($combinedIdentifier, '__') === FALSE) {
            $dataProviderIdentifier = 'default';
            $backendLayoutIdentifier = $combinedIdentifier;
        } else {
            list($dataProviderIdentifier, $backendLayoutIdentifier) = explode('__', $combinedIdentifier, 2);
        }

        if (isset($this->dataProviders[$dataProviderIdentifier])) {
            $backendLayout = $this->dataProviders[$dataProviderIdentifier]->getBackendLayout($backendLayoutIdentifier, $pageId);
        }

        return $backendLayout;
    }

    protected function createBackendLayoutCollection($identifier) {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
            'TYPO3\\CMS\\Backend\\View\\BackendLayout\\BackendLayoutCollection', $identifier
        );
    }

}