DataProviderCollection implements SingletonInterface
Collection of backend layout data providers.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Properties
- $dataProviders : array<string|int, DataProviderInterface>
- $results : array<string|int, mixed>
Methods
- add() : void
- Adds a data provider to this collection.
- getBackendLayout() : BackendLayout|null
- 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.
- getBackendLayoutCollections() : array<string|int, BackendLayoutCollection>
- Gets all backend layout collections and thus, all backend layouts. Each data provider returns its own backend layout collection.
- createBackendLayoutCollection() : BackendLayoutCollection
- Creates a new backend layout collection.
Properties
$dataProviders
protected
array<string|int, DataProviderInterface>
$dataProviders
= []
$results
protected
array<string|int, mixed>
$results
= []
Methods
add()
Adds a data provider to this collection.
public
add(string $identifier, string|object $classNameOrObject) : void
Parameters
- $identifier : string
- $classNameOrObject : string|object
getBackendLayout()
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.
public
getBackendLayout(string $combinedIdentifier, int $pageId) : BackendLayout|null
Parameters
- $combinedIdentifier : string
- $pageId : int
Return values
BackendLayout|nullgetBackendLayoutCollections()
Gets all backend layout collections and thus, all backend layouts. Each data provider returns its own backend layout collection.
public
getBackendLayoutCollections(DataProviderContext $dataProviderContext) : array<string|int, BackendLayoutCollection>
Parameters
- $dataProviderContext : DataProviderContext
Return values
array<string|int, BackendLayoutCollection>createBackendLayoutCollection()
Creates a new backend layout collection.
protected
createBackendLayoutCollection(string $identifier) : BackendLayoutCollection
Parameters
- $identifier : string