‪TYPO3CMS  ‪main
TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection Class Reference
Inheritance diagram for TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 add ($identifier, $classNameOrObject)
 
array BackendLayoutCollection[] getBackendLayoutCollections (DataProviderContext $dataProviderContext)
 
BackendLayout null getBackendLayout ($combinedIdentifier, $pageId)
 

Protected Member Functions

BackendLayoutCollection createBackendLayoutCollection ($identifier)
 

Protected Attributes

array DataProviderInterface[] $dataProviders = array( )
 
array $results = array( )
 

Detailed Description

Collection of backend layout data providers.

Definition at line 24 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\Backend\View\BackendLayout\BackendLayout\$identifier.

◆ createBackendLayoutCollection()

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

Creates a new backend layout collection.

Parameters
string$identifier
Returns
BackendLayoutCollection

Definition at line 123 of file DataProviderCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$identifier.

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

◆ getBackendLayout()

BackendLayout null 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
int$pageId
Returns
‪BackendLayout|null

Definition at line 99 of file DataProviderCollection.php.

◆ getBackendLayoutCollections()

array BackendLayoutCollection [] 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.

Returns
‪array|BackendLayoutCollection[]

Definition at line 76 of file DataProviderCollection.php.

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

Member Data Documentation

◆ $dataProviders

array DataProviderInterface [] TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection::$dataProviders = array( )
protected

Definition at line 28 of file DataProviderCollection.php.

◆ $results

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

Definition at line 32 of file DataProviderCollection.php.