Class TPageConfiguration

Description
Description | Methods (details)

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.

  • since: 3.0
  • version: $Id: TPageService.php 1490 2006-11-04 03:33:00Z xue $
  • author: Qiang Xue <qiang.xue@gmail.com>

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

TComponent
   |
   --TPageConfiguration
Method Summary
Description | Methods (details)
array getAliases ()
array getModules ()
array getParameters ()
array getProperties ()
TAuthorizationRuleCollection getRules ()
array getUsings ()
void loadConfigurationFiles (string $pagePath, string $basePath)
void loadXmlElement (TXmlElement $dom, string $configPath, string $page)
Methods
Description | Methods (details)
getAliases (line 533)

Returns list of path alias definitions.

The definitions are aggregated (top-down) from configuration files along the path to the specified page. Each array element represents a single alias definition, with the key being the alias name and the value the absolute path.

  • return: list of path alias definitions
  • access: public
array getAliases ()
getModules (line 564)

Returns list of module configurations.

The module configurations are aggregated (top-down) from configuration files along the path to the specified page. Each array element represents a single module configuration, with the key being the module ID and the value the module configuration. Each module configuration is stored in terms of an array with the following content ([0]=>module type, [1]=>module properties, [2]=>complete module configuration) The module properties are an array of property values indexed by property names. The complete module configuration is a TXmlElement object representing the raw module configuration which may contain contents enclosed within module tags.

  • return: list of module configurations to be used
  • access: public
array getModules ()
getParameters (line 581)

Returns list of parameter definitions.

The parameter definitions are aggregated (top-down) from configuration files along the path to the specified page. Each array element represents a single parameter definition, with the key being the parameter ID and the value the parameter definition. A parameter definition can be either a string representing a string-typed parameter, or an array. The latter defines a component-typed parameter whose format is as follows, ([0]=>component type, [1]=>component properties) The component properties are an array of property values indexed by property names.

  • return: list of parameter definitions to be used
  • access: public
array getParameters ()
getProperties (line 521)

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 592)

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
TAuthorizationRuleCollection getRules ()
getUsings (line 545)

Returns list of namespaces to be used.

The namespaces are aggregated (top-down) from configuration files along the path to the specified page. Each array element represents a single namespace usage, with the value being the namespace to be used.

  • return: list of namespaces to be used
  • access: public
array getUsings ()
loadConfigurationFiles (line 602)

Loads configuration for a page specified in a path format.

  • access: public
void loadConfigurationFiles (string $pagePath, string $basePath)
  • string $pagePath: path to the page (dot-connected format)
  • string $basePath: root path for pages
loadXmlElement (line 639)

Loads a specific configuration xml element.

  • access: public
void loadXmlElement (TXmlElement $dom, string $configPath, string $page)
  • TXmlElement $dom: config xml element
  • string $configPath: base path corresponding to this xml element
  • string $page: page name, null if page is not required

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::__get()
TComponent::__set()

Documentation generated on Sun, 14 Jan 2007 21:43:47 -0500 by phpDocumentor 1.3.0RC4