ThemeConfiguration
in package
This is the ThemeConfiguration class.
This is a functional class responsible to agglutinate various usefull methods related to theme configurations.
This class generally bridges the 'Theme' and its corresponding 'theme configuration':
in most methods, given a 'Theme' its corresponding 'theme configuration' is searched
and instantiated and the necessary actions are performed based on it.
Tags
Table of Contents
| addBatchRequests() | This method adds the given batch request to the configuration of the given theme, and it also adds the root batch requests if the routeType of the given theme requires the RootBatchRequest. | : mixed |
|---|---|---|
| getCalculatedData() | This method invokes the getCalculatedData method of the configuration of the theme given by parameter. | : array<string|int, mixed> |
| getConfiguration() | This method returns the 'theme configuration' data (encapsulated in a Configuration object) of the given theme. | : Configuration |
| runForbiddenResponse() | This method invokes the runForbiddenResponse method of the configuration of the theme given by parameter. | : void |
Methods
addBatchRequests()
This method adds the given batch request to the configuration of the given theme, and it also adds the root batch requests if the routeType of the given theme requires the RootBatchRequest.
public
static addBatchRequests(BatchRequests $requests, Theme $theme) : mixed
Parameters
- $requests : BatchRequests
- $theme : Theme
Return values
mixed —getCalculatedData()
This method invokes the getCalculatedData method of the configuration of the theme given by parameter.
public
static getCalculatedData(array<string|int, mixed> $batchResult, Theme $theme) : array<string|int, mixed>
Parameters
- $batchResult : array<string|int, mixed>
- $theme : Theme
Tags
Return values
array<string|int, mixed> —getConfiguration()
This method returns the 'theme configuration' data (encapsulated in a Configuration object) of the given theme.
public
static getConfiguration(Theme $theme) : Configuration
Parameters
- $theme : Theme
Tags
Return values
Configuration —runForbiddenResponse()
This method invokes the runForbiddenResponse method of the configuration of the theme given by parameter.
public
static runForbiddenResponse(Theme $theme) : void
Parameters
- $theme : Theme