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|DataProviderInterface[]
- $results : array
Methods
- add() : mixed
- 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|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|DataProviderInterface[]
$dataProviders
= []
$results
protected
array
$results
= []
Methods
add()
Adds a data provider to this collection.
public
add(string $identifier, string|object $classNameOrObject) : mixed
Parameters
- $identifier : string
- $classNameOrObject : string|object
Tags
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|BackendLayoutCollection[]
Parameters
- $dataProviderContext : DataProviderContext
Return values
array|BackendLayoutCollection[]createBackendLayoutCollection()
Creates a new backend layout collection.
protected
createBackendLayoutCollection(string $identifier) : BackendLayoutCollection
Parameters
- $identifier : string