TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection:

Public Member Functions
	add ($identifier, $classNameOrObject)
	getBackendLayoutCollections (DataProviderContext $dataProviderContext)
	getBackendLayout ($combinedIdentifier, $pageId)

Protected Member Functions
	createBackendLayoutCollection ($identifier)

Protected Attributes
	$dataProviders = array()
	$results = array()

Detailed Description

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! Collection of backend layout data providers.

Author

Oliver Hader olive.nosp@m.r.ha.nosp@m.der@t.nosp@m.ypo3.nosp@m..org

Definition at line 22 of file DataProviderCollection.php.

Member Function Documentation

add()

TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::add	(		$identifier,
			$classNameOrObject
	)

Adds a data provider to this collection.

Parameters

string	$identifier
string | object	$classNameOrObject

Exceptions

Definition at line 42 of file DataProviderCollection.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

createBackendLayoutCollection()

TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::createBackendLayoutCollection (   $identifier )

protected

Creates a new backend layout collection.

Parameters

string

$identifier

Returns

BackendLayoutCollection

Definition at line 121 of file DataProviderCollection.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\getBackendLayoutCollections().

getBackendLayout()

TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::getBackendLayout	(		$combinedIdentifier,
			$pageId
	)

Gets a backend layout by a combined identifier, which is e.g. "myextension_regular" and "myextension" is the identifier of the accordant data provider and "regular" the identifier of the accordant backend layout.

Parameters

string	$combinedIdentifier
integer	$pageId

Returns

NULL|BackendLayout

Definition at line 98 of file DataProviderCollection.php.

getBackendLayoutCollections()

TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::getBackendLayoutCollections

(

DataProviderContext

$dataProviderContext

)

Gets all backend layout collections and thus, all backend layouts. Each data provider returns its own backend layout collection.

Parameters

DataProviderContext

$dataProviderContext

Returns

array|BackendLayoutCollection[]

Definition at line 76 of file DataProviderCollection.php.

References $result, and TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\createBackendLayoutCollection().

Member Data Documentation

$dataProviders

TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::$dataProviders = array()

protected

Definition at line 27 of file DataProviderCollection.php.

$results

TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::$results = array()

protected

Definition at line 32 of file DataProviderCollection.php.