DataProviderCollection Class Reference

Inheritance diagram for 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

Collection of backend layout data providers.

Definition at line 20 of file DataProviderCollection.php.

Member Function Documentation

add	(		$identifier,
			$classNameOrObject
	)

Adds a data provider to this collection.

Parameters

string	$identifier
string | object	$classNameOrObject

Exceptions

\UnexpectedValueException
\LogicException

Definition at line 40 of file DataProviderCollection.php.

createBackendLayoutCollection (   $identifier )

protected

Creates a new backend layout collection.

Parameters

string

$identifier

Returns

BackendLayoutCollection

Definition at line 122 of file DataProviderCollection.php.

Referenced by DataProviderCollection\getBackendLayoutCollections().

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

NULL|BackendLayout

Definition at line 98 of file DataProviderCollection.php.

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 75 of file DataProviderCollection.php.

References DataProviderCollection\createBackendLayoutCollection().

Member Data Documentation

$dataProviders = array()

protected

Definition at line 25 of file DataProviderCollection.php.

$results = array()

protected

Definition at line 30 of file DataProviderCollection.php.