Class TPageConfiguration

Description

TPageConfiguration class

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.

  • author: Qiang Xue <qiang.xue@gmail.com>
  • version: $Id: TPageService.php 3079 2011-12-05 16:30:49Z ctrlaltca@gmail.com $
  • since: 3.0

Located in /Web/Services/TPageService.php (line 554)

TComponent
   |
   --TPageConfiguration
Method Summary
TPageConfiguration __construct (string $pagePath)
array getProperties ()
void loadApplicationConfigurationFromPhp ( $config,  $configPath)
void loadApplicationConfigurationFromXml (TXmlElement $dom, string $configPath)
void loadFromFile (string $fname, string $configPagePath)
void loadFromFiles (string $basePath)
void loadFromPhp ( $config,  $configPath,  $configPagePath)
void loadFromXml (TXmlElement $dom, string $configPath, string $configPagePath)
void loadPageConfigurationFromPhp ( $config,  $configPath,  $configPagePath)
void loadPageConfigurationFromXml (TXmlElement $dom, string $configPath, string $configPagePath)
Methods
Constructor __construct (line 581)

Constructor.

  • access: public
TPageConfiguration __construct (string $pagePath)
  • string $pagePath: the currently request page in the format of Path.To.PageName
getApplicationConfigurations (line 619)
  • return: list of application configurations specified along page path
  • access: public
array getApplicationConfigurations ()
getExternalConfigurations (line 589)
  • return: list of external configuration files. Each element is like $filePath=>$condition
  • access: public
array getExternalConfigurations ()
getProperties (line 600)

Returns list of page initial property values.

Each array element represents a single property with the key being the property name and the value the initial property value.

  • return: list of page initial property values
  • access: public
array getProperties ()
getRules (line 611)

Returns list of authorization rules.

The authorization rules are aggregated (bottom-up) from configuration files along the path to the specified page.

  • return: collection of authorization rules
  • access: public
loadApplicationConfigurationFromPhp (line 696)
  • access: public
void loadApplicationConfigurationFromPhp ( $config,  $configPath)
  • $config
  • $configPath
loadApplicationConfigurationFromXml (line 708)

Loads the configuration specific for application part

  • access: public
void loadApplicationConfigurationFromXml (TXmlElement $dom, string $configPath)
  • TXmlElement $dom: config xml element
  • string $configPath: base path corresponding to this xml element
loadFromFile (line 655)

Loads a specific config file.

  • access: public
void loadFromFile (string $fname, string $configPagePath)
  • string $fname: config file name
  • string $configPagePath: the page path that the config file is associated with. The page path doesn't include the page name.
loadFromFiles (line 628)

Loads configuration for a page specified in a path format.

  • access: public
void loadFromFiles (string $basePath)
  • string $basePath: root path for pages
loadFromPhp (line 676)
  • access: public
void loadFromPhp ( $config,  $configPath,  $configPagePath)
  • $config
  • $configPath
  • $configPagePath
loadFromXml (line 690)

Loads a page configuration.

The configuration includes information for both application and page service.

  • access: public
void loadFromXml (TXmlElement $dom, string $configPath, string $configPagePath)
  • TXmlElement $dom: config xml element
  • string $configPath: the directory containing this configuration
  • string $configPagePath: the page path that the config XML is associated with. The page path doesn't include the page name.
loadPageConfigurationFromPhp (line 715)
  • access: public
void loadPageConfigurationFromPhp ( $config,  $configPath,  $configPagePath)
  • $config
  • $configPath
  • $configPagePath
loadPageConfigurationFromXml (line 814)

Loads the configuration specific for page service.

  • access: public
void loadPageConfigurationFromXml (TXmlElement $dom, string $configPath, string $configPagePath)
  • TXmlElement $dom: config xml element
  • string $configPath: base path corresponding to this xml element
  • string $configPagePath: the page path that the config XML is associated with. The page path doesn't include the page name.

Inherited Methods

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()

Documentation generated on Mon, 25 Jun 2012 14:38:51 +0200 by phpDocumentor 1.4.3