PHP Class Prado\Web\Services\TPageConfiguration

TPageConfiguration represents the configuration for a page. The page is specified by a dot-connected path. Configurations along this path are merged together to be provided for the page.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends Prado\TComponent
Show file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
__construct ( $pagePath ) Constructor.
getApplicationConfigurations ( ) : array
getExternalConfigurations ( ) : array
getProperties ( ) : array Returns list of page initial property values.
getRules ( ) : TAuthorizationRuleCollection Returns list of authorization rules.
loadApplicationConfigurationFromPhp ( $config, $configPath )
loadApplicationConfigurationFromXml ( $dom, $configPath ) Loads the configuration specific for application part
loadFromFile ( $fname, $configPagePath ) Loads a specific config file.
loadFromFiles ( $basePath ) Loads configuration for a page specified in a path format.
loadFromPhp ( $config, $configPath, $configPagePath )
loadFromXml ( $dom, $configPath, $configPagePath ) Loads a page configuration.
loadPageConfigurationFromPhp ( $config, $configPath, $configPagePath )
loadPageConfigurationFromXml ( $dom, $configPath, $configPagePath ) Loads the configuration specific for page service.

Method Details

__construct() public method

Constructor.
public __construct ( $pagePath )

getApplicationConfigurations() public method

public getApplicationConfigurations ( ) : array
return array list of application configurations specified along page path

getExternalConfigurations() public method

public getExternalConfigurations ( ) : array
return array list of external configuration files. Each element is like $filePath=>$condition

getProperties() public method

Each array element represents a single property with the key being the property name and the value the initial property value.
public getProperties ( ) : array
return array list of page initial property values

getRules() public method

The authorization rules are aggregated (bottom-up) from configuration files along the path to the specified page.
public getRules ( ) : TAuthorizationRuleCollection
return Prado\Security\TAuthorizationRuleCollection collection of authorization rules

loadApplicationConfigurationFromPhp() public method

public loadApplicationConfigurationFromPhp ( $config, $configPath )

loadApplicationConfigurationFromXml() public method

Loads the configuration specific for application part
public loadApplicationConfigurationFromXml ( $dom, $configPath )

loadFromFile() public method

Loads a specific config file.
public loadFromFile ( $fname, $configPagePath )

loadFromFiles() public method

Loads configuration for a page specified in a path format.
public loadFromFiles ( $basePath )

loadFromPhp() public method

public loadFromPhp ( $config, $configPath, $configPagePath )

loadFromXml() public method

The configuration includes information for both application and page service.
public loadFromXml ( $dom, $configPath, $configPagePath )

loadPageConfigurationFromPhp() public method

public loadPageConfigurationFromPhp ( $config, $configPath, $configPagePath )

loadPageConfigurationFromXml() public method

Loads the configuration specific for page service.
public loadPageConfigurationFromXml ( $dom, $configPath, $configPagePath )