DataProviderCollection
class \
- Implements
- SingletonInterface
Collection of backend layout data providers.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Properties
- $dataProviders : array<non-empty-string, DataProviderInterface>
- $results : array
Methods
- __construct() : mixed
- 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() : 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.
- validateDataProvider() : void
Properties
$dataProviders
protected
array<non-empty-string, DataProviderInterface>
$dataProviders
= []
$results
protected
array
$results
= []
Methods
__construct()
public
__construct([iterable<string|int, DataProviderInterface> $dataProviders = [] ]) : mixed
Parameters
- $dataProviders : iterable<string|int, DataProviderInterface> = []
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) : BackendLayoutCollection[]
Parameters
- $dataProviderContext : DataProviderContext
Return values
BackendLayoutCollection[]createBackendLayoutCollection()
Creates a new backend layout collection.
protected
createBackendLayoutCollection(string $identifier) : BackendLayoutCollection
Parameters
- $identifier : string
Return values
BackendLayoutCollectionvalidateDataProvider()
protected
validateDataProvider(mixed $dataProvider) : void
Parameters
- $dataProvider : mixed