PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TApplicationConfiguration

TApplicationConfiguration class.

This class is used internally by TApplication to parse and represent application configuration.

TComponent
Extended by TApplicationConfiguration
Package: System
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Author: Carl G. Mathisen <carlgmathisen@gmail.com>
Since: 3.0
Located at TApplication.php
Methods summary
public
# loadFromFile( string $fname )

Parses the application configuration file.

Parses the application configuration file.

Parameters

$fname
string
configuration file name

Throws

TConfigurationException
if there is any parsing error
public boolean
# getIsEmpty( )

Returns

boolean
whether this configuration contains actual stuff
public
# loadFromPhp( array $config, string $configPath )

Parses the application configuration given in terms of a PHP array.

Parses the application configuration given in terms of a PHP array.

Parameters

$config
array
the PHP array
$configPath
string
the context path (for specifying relative paths)
public
# loadFromXml( TXmlElement $dom, string $configPath )

Parses the application configuration given in terms of a TXmlElement.

Parses the application configuration given in terms of a TXmlElement.

Parameters

$dom
TXmlElement
the XML element
$configPath
string
the context path (for specifying relative paths)
protected
# loadPathsPhp( array $pathsNode, string $configPath )

Loads the paths PHP array

Loads the paths PHP array

Parameters

$pathsNode
array
the paths PHP array
$configPath
string
the context path (for specifying relative paths)
protected
# loadPathsXml( TXmlElement $pathsNode, string $configPath )

Loads the paths XML node.

Loads the paths XML node.

Parameters

$pathsNode
TXmlElement
the paths XML node
$configPath
string
the context path (for specifying relative paths)
protected
# loadModulesPhp( array $modulesNode, string $configPath )

Loads the modules PHP array.

Loads the modules PHP array.

Parameters

$modulesNode
array
the modules PHP array
$configPath
string
the context path (for specifying relative paths)
protected
# loadModulesXml( TXmlElement $modulesNode, string $configPath )

Loads the modules XML node.

Loads the modules XML node.

Parameters

$modulesNode
TXmlElement
the modules XML node
$configPath
string
the context path (for specifying relative paths)
protected
# loadServicesPhp( array $servicesNode, string $configPath )

Loads the services PHP array.

Loads the services PHP array.

Parameters

$servicesNode
array
the services PHP array
$configPath
string
the context path (for specifying relative paths)
protected
# loadServicesXml( TXmlElement $servicesNode, string $configPath )

Loads the services XML node.

Loads the services XML node.

Parameters

$servicesNode
TXmlElement
the services XML node
$configPath
string
the context path (for specifying relative paths)
protected
# loadParametersPhp( array $parametersNode, string $configPath )

Loads the parameters PHP array.

Loads the parameters PHP array.

Parameters

$parametersNode
array
the parameters PHP array
$configPath
string
the context path (for specifying relative paths)
protected
# loadParametersXml( TXmlElement $parametersNode, string $configPath )

Loads the parameters XML node.

Loads the parameters XML node.

Parameters

$parametersNode
TXmlElement
the parameters XML node
$configPath
string
the context path (for specifying relative paths)
protected
# loadExternalPhp( array $includeNode, string $configPath )

Loads the external PHP array.

Loads the external PHP array.

Parameters

$includeNode
array
the application PHP array
$configPath
string
the context path (for specifying relative paths)
protected
# loadExternalXml( TXmlElement $includeNode, string $configPath )

Loads the external XML configurations.

Loads the external XML configurations.

Parameters

$includeNode
TXmlElement
the application DOM element
$configPath
string
the context path (for specifying relative paths)
public array
# getProperties( )

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.

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.

Returns

array
list of page initial property values
public array
# getAliases( )

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.

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.

Returns

array
list of path alias definitions
public array
# getUsings( )

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.

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.

Returns

array
list of namespaces to be used
public array
# getModules( )

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.

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.

Returns

array
list of module configurations to be used
public array
# getServices( )

Returns

array
list of service configurations
public array
# getParameters( )

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.

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.

Returns

array
list of parameter definitions to be used
public array
# getExternalConfigurations( )

Returns

array
list of external configuration files. Each element is like $filePath=>$condition
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO