Class: I2CE SwissConfigFactory: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_SwissFactory | I2CE_SwissFactory]].
*Extends the class: [[Class: I2CE_SwissFactory | I2CE_SwissFactory]].
*Location: Part of the module [[I2CE Module List#swissConfig|swissConfig]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#swissConfig|swissConfig]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L29 modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 29
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissConfigFactory
I2CE_SwissConfigFactory
Line 8: Line 8:
===$configNodes===
===$configNodes===
@var protected DOMNode $configNode
@var protected DOMNode $configNode
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L72 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 72
*Type: protected $configNodes
*Type: protected $configNodes


===$statii===
===$statii===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L73 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 73
*Type: protected $statii
*Type: protected $statii


===$module===
===$module===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L100 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 100
*Type: protected $module
*Type: protected $module


===$translatedConfigs===
===$translatedConfigs===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L158 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 158
*Type: protected $translatedConfigs
*Type: protected $translatedConfigs


===$child_node_cache===
===$child_node_cache===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L370 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 370
*Type: protected $child_node_cache
*Type: protected $child_node_cache


===$child_node_cache_index===
===$child_node_cache_index===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L371 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 371
*Type: protected $child_node_cache_index
*Type: protected $child_node_cache_index


Line 28: Line 34:
===__construct()===
===__construct()===
construct a swiss swiss factory and create it if it doesn't exist. @param I2CE_MagicDataNode $storage.  The root of the magic data we will be operating on @param string  $swissName.  The classname for the root swiss object. @throws Exception
construct a swiss swiss factory and create it if it doesn't exist. @param I2CE_MagicDataNode $storage.  The root of the magic data we will be operating on @param string  $swissName.  The classname for the root swiss object. @throws Exception
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L107 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 107
*Signature: public function __construct($page,$options)
*Signature: public function __construct($page,$options)
*Parameters:
*Parameters:
Line 34: Line 41:
***Default Value: array()
***Default Value: array()
===count()===
===count()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L434 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 434
*Signature: public function count($swiss)
*Signature: public function count($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===displayValues()===
===displayValues()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L346 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 346
*Signature: public function displayValues($contentNode,$path,$transient_options)
*Signature: public function displayValues($contentNode,$path,$transient_options)
*Parameters:
*Parameters:
Line 44: Line 53:
**$transient_options  
**$transient_options  
===editValues()===
===editValues()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L353 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 353
*Signature: public function editValues($contentNode,$path,$transient_options)
*Signature: public function editValues($contentNode,$path,$transient_options)
*Parameters:
*Parameters:
Line 50: Line 60:
**$transient_options  
**$transient_options  
===ensureIterator()===
===ensureIterator()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L377 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 377
*Signature: protected function ensureIterator($swiss)
*Signature: protected function ensureIterator($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===getAttribute()===
===getAttribute()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L319 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 319
*Signature: public function getAttribute($swiss,$attr)
*Signature: public function getAttribute($swiss,$attr)
*Parameters:
*Parameters:
Line 59: Line 71:
**$attr  
**$attr  
===getChildConfigNode()===
===getChildConfigNode()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L86 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 86
*Signature: protected function getChildConfigNode($node,$child)
*Signature: protected function getChildConfigNode($node,$child)
*Parameters:
*Parameters:
Line 64: Line 77:
**$child  
**$child  
===getChildConfigNodes()===
===getChildConfigNodes()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L241 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 241
*Signature: protected function getChildConfigNodes($swiss,$child)
*Signature: protected function getChildConfigNodes($swiss,$child)
*Parameters:
*Parameters:
Line 70: Line 84:
***Default Value: null
***Default Value: null
===getChildNames()===
===getChildNames()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L55 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 55
*Signature: public function getChildNames($swiss)
*Signature: public function getChildNames($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===getChildStorage()===
===getChildStorage()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L193 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 193
*Signature: public function getChildStorage($swiss,$child,$create)
*Signature: public function getChildStorage($swiss,$child,$create)
*Parameters:
*Parameters:
Line 82: Line 98:
***Default Value: false
***Default Value: false
===getChildType()===
===getChildType()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L256 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 256
*Signature: public function getChildType($swiss,$child)
*Signature: public function getChildType($swiss,$child)
*Parameters:
*Parameters:
Line 87: Line 104:
**$child  
**$child  
===getConfigNode()===
===getConfigNode()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L74 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 74
*Signature: public function getConfigNode($swiss)
*Signature: public function getConfigNode($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===getDescription()===
===getDescription()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L290 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 290
*Signature: public function getDescription($swiss)
*Signature: public function getDescription($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===getDisplayName()===
===getDisplayName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L304 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 304
*Signature: public function getDisplayName($swiss)
*Signature: public function getDisplayName($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===getRootStorage()===
===getRootStorage()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L169 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 169
*Signature: protected function getRootStorage()
*Signature: protected function getRootStorage()
===getRootType()===
===getRootType()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L160 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 160
*Signature: protected function getRootType()
*Signature: protected function getRootType()
===getStatus()===
===getStatus()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L336 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 336
*Signature: public function getStatus($swiss)
*Signature: public function getStatus($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===getTranslatedContentAtPath()===
===getTranslatedContentAtPath()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L268 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 268
*Signature: protected function getTranslatedContentAtPath($tag,$path)
*Signature: protected function getTranslatedContentAtPath($tag,$path)
*Parameters:
*Parameters:
Line 112: Line 136:
**$path  
**$path  
===getURLRoot()===
===getURLRoot()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L232 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 232
*Signature: public function getURLRoot($action)
*Signature: public function getURLRoot($action)
*Parameters:
*Parameters:
Line 117: Line 142:
***Default Value: null
***Default Value: null
===hasAttribute()===
===hasAttribute()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L326 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 326
*Signature: public function hasAttribute($swiss,$attr)
*Signature: public function hasAttribute($swiss,$attr)
*Parameters:
*Parameters:
Line 122: Line 148:
**$attr  
**$attr  
===key()===
===key()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L394 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 394
*Signature: public function key($swiss)
*Signature: public function key($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===next()===
===next()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L406 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 406
*Signature: public function next($swiss)
*Signature: public function next($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===rewind()===
===rewind()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L412 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 412
*Signature: public function rewind($swiss)
*Signature: public function rewind($swiss)
*Parameters:
*Parameters:
**$swiss  
**$swiss  
===setupNode()===
===setupNode()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L32 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 32
*Signature: protected function setupNode($path)
*Signature: protected function setupNode($path)
*Parameters:
*Parameters:
**$path  
**$path  
===valid()===
===valid()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php#L418 i2ce/modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php] on line 418
*Signature: public function valid($swiss)
*Signature: public function valid($swiss)
*Parameters:
*Parameters:

Revision as of 08:52, 10 November 2009

This article describes the class I2CE_SwissConfigFactory.

I2CE_SwissConfigFactory

Variables

$configNodes

@var protected DOMNode $configNode

$statii

$module

$translatedConfigs

$child_node_cache

$child_node_cache_index

Methods

__construct()

construct a swiss swiss factory and create it if it doesn't exist. @param I2CE_MagicDataNode $storage. The root of the magic data we will be operating on @param string $swissName. The classname for the root swiss object. @throws Exception

count()

displayValues()

editValues()

ensureIterator()

getAttribute()

getChildConfigNode()

getChildConfigNodes()

getChildNames()

getChildStorage()

getChildType()

getConfigNode()

getDescription()

getDisplayName()

getRootStorage()

getRootType()

getStatus()

getTranslatedContentAtPath()

getURLRoot()

hasAttribute()

key()

next()

rewind()

setupNode()

valid()

Inherited Methods

current()

This public method is inherited from I2CE_SwissFactory->current()

getPage()

This public method is inherited from I2CE_SwissFactory->getPage()

getPath()

This public method is inherited from I2CE_SwissFactory->getPath()

getPathComponents()

This public method is inherited from I2CE_SwissFactory->getPathComponents()

getStorage()

This public method is inherited from I2CE_SwissFactory->getStorage()

getStoredOptions()

This public method is inherited from I2CE_SwissFactory->getStoredOptions()

getSwiss()

This public method is inherited from I2CE_SwissFactory->getSwiss()

getURLQueryString()

This public method is inherited from I2CE_SwissFactory->getURLQueryString()

humanText()

This public method is inherited from I2CE_SwissFactory->humanText()

setRedirect()

This public method is inherited from I2CE_SwissFactory->setRedirect()

setRootSwiss()

This public method is inherited from I2CE_SwissFactory->setRootSwiss()

setStoredOptions()

This public method is inherited from I2CE_SwissFactory->setStoredOptions()

updateValues()

This public method is inherited from I2CE_SwissFactory->updateValues()

setupDisplay()

This protected method is inherited from I2CE_SwissFactory->setupDisplay()

Inherited Variables

$page

Theis protected variable is inherited from I2CE_SwissFactory->$page

$swiss

Theis protected variable is inherited from I2CE_SwissFactory->$swiss

$stored_options

Theis protected variable is inherited from I2CE_SwissFactory->$stored_options

$template

Theis protected variable is inherited from I2CE_SwissFactory->$template

$style

Theis protected variable is inherited from I2CE_SwissFactory->$style