|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_SwissConfigFactory''.
| | #REDIRECT [[Class: I2CE_SwissConfigFactory (4.0.3)]] |
| *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]
| |
| *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>
| |
| I2CE_SwissConfigFactory
| |
| ==Variables==
| |
| ===$configNodes===
| |
| @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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ==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
| |
| *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)
| |
| *Parameters:
| |
| **$page
| |
| **$options
| |
| ***Default Value: array()
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$contentNode
| |
| **$path
| |
| **$transient_options
| |
| ===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)
| |
| *Parameters:
| |
| **$contentNode
| |
| **$path
| |
| **$transient_options
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| **$attr
| |
| ===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)
| |
| *Parameters:
| |
| **$node
| |
| **$child
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| **$child
| |
| ***Default Value: null
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| **$child
| |
| ***Default Value: null
| |
| **$create
| |
| ***Default Value: false
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| **$child
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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()
| |
| ===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()
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$tag
| |
| **$path
| |
| ===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)
| |
| *Parameters:
| |
| **$action
| |
| ***Default Value: null
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| **$attr
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ===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)
| |
| *Parameters:
| |
| **$path
| |
| ===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)
| |
| *Parameters:
| |
| **$swiss
| |
| ==Inherited Methods==
| |
| ===current()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#current() | I2CE_SwissFactory->current()]]
| |
| | |
| ===getPage()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getPage() | I2CE_SwissFactory->getPage()]]
| |
| | |
| ===getPath()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getPath() | I2CE_SwissFactory->getPath()]]
| |
| | |
| ===getPathComponents()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getPathComponents() | I2CE_SwissFactory->getPathComponents()]]
| |
| | |
| ===getStorage()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getStorage() | I2CE_SwissFactory->getStorage()]]
| |
| | |
| ===getStoredOptions()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getStoredOptions() | I2CE_SwissFactory->getStoredOptions()]]
| |
| | |
| ===getSwiss()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getSwiss() | I2CE_SwissFactory->getSwiss()]]
| |
| | |
| ===getURLQueryString()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#getURLQueryString() | I2CE_SwissFactory->getURLQueryString()]]
| |
| | |
| ===humanText()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#humanText() | I2CE_SwissFactory->humanText()]]
| |
| | |
| ===setRedirect()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#setRedirect() | I2CE_SwissFactory->setRedirect()]]
| |
| | |
| ===setRootSwiss()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#setRootSwiss() | I2CE_SwissFactory->setRootSwiss()]]
| |
| | |
| ===setStoredOptions()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#setStoredOptions() | I2CE_SwissFactory->setStoredOptions()]]
| |
| | |
| ===updateValues()===
| |
| This public method is inherited from [[Class: I2CE_SwissFactory#updateValues() | I2CE_SwissFactory->updateValues()]]
| |
| | |
| ===setupDisplay()===
| |
| This protected method is inherited from [[Class: I2CE_SwissFactory#setupDisplay() | I2CE_SwissFactory->setupDisplay()]]
| |
| ==Inherited Variables==
| |
| ===$page===
| |
| Theis protected variable is inherited from [[Class: I2CE_SwissFactory#$page | I2CE_SwissFactory->$page]]
| |
| | |
| ===$swiss===
| |
| Theis protected variable is inherited from [[Class: I2CE_SwissFactory#$swiss | I2CE_SwissFactory->$swiss]]
| |
| | |
| ===$stored_options===
| |
| Theis protected variable is inherited from [[Class: I2CE_SwissFactory#$stored_options | I2CE_SwissFactory->$stored_options]]
| |
| | |
| ===$template===
| |
| Theis protected variable is inherited from [[Class: I2CE_SwissFactory#$template | I2CE_SwissFactory->$template]]
| |
| | |
| ===$style===
| |
| Theis protected variable is inherited from [[Class: I2CE_SwissFactory#$style | I2CE_SwissFactory->$style]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
