DataProviderInterface
Interface for classes which hook into BackendLayoutDataProvider to provide additional backend layouts from various sources.
Attributes
- #[AutoconfigureTag]
- 'page_layout.data_provider'
Table of Contents
Methods
- addBackendLayouts() : mixed
- Adds backend layouts to the given backend layout collection.
- getBackendLayout() : BackendLayout|null
- Gets a backend layout by (regular) identifier.
- getIdentifier() : non-empty-string
- Returns the unique identifier for this backend layout data provider.
Methods
addBackendLayouts()
Adds backend layouts to the given backend layout collection.
public
addBackendLayouts(DataProviderContext $dataProviderContext, BackendLayoutCollection $backendLayoutCollection) : mixed
Parameters
- $dataProviderContext : DataProviderContext
- $backendLayoutCollection : BackendLayoutCollection
getBackendLayout()
Gets a backend layout by (regular) identifier.
public
getBackendLayout(string $identifier, int $pageId) : BackendLayout|null
Parameters
- $identifier : string
- $pageId : int
Return values
BackendLayout|nullgetIdentifier()
Returns the unique identifier for this backend layout data provider.
public
getIdentifier() : non-empty-string
This identifier is used to build combined identifiers in the format "providerIdentifier__layoutIdentifier" (e.g., "my_provider__my_layout").
Requirements:
- Must be a non-empty string
- Must not contain double underscores "__" (reserved as separator)
- Must be unique across all registered backend layout data providers
Return values
non-empty-string —The unique identifier for this data provider