Class: I2CE SwissConfigFactory: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 30: | Line 30: | ||
*Signature: public function __construct($page,$options) | *Signature: public function __construct($page,$options) | ||
*Parameters: | *Parameters: | ||
*$page | **$page | ||
*$options | **$options | ||
***Default Value: array() | ***Default Value: array() | ||
===count()=== | ===count()=== | ||
*Signature: public function count($swiss) | *Signature: public function count($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===displayValues()=== | ===displayValues()=== | ||
*Signature: public function displayValues($contentNode,$path,$transient_options) | *Signature: public function displayValues($contentNode,$path,$transient_options) | ||
*Parameters: | *Parameters: | ||
*$contentNode | **$contentNode | ||
*$path | **$path | ||
*$transient_options | **$transient_options | ||
===editValues()=== | ===editValues()=== | ||
*Signature: public function editValues($contentNode,$path,$transient_options) | *Signature: public function editValues($contentNode,$path,$transient_options) | ||
*Parameters: | *Parameters: | ||
*$contentNode | **$contentNode | ||
*$path | **$path | ||
*$transient_options | **$transient_options | ||
===ensureIterator()=== | ===ensureIterator()=== | ||
*Signature: protected function ensureIterator($swiss) | *Signature: protected function ensureIterator($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getAttribute()=== | ===getAttribute()=== | ||
*Signature: public function getAttribute($swiss,$attr) | *Signature: public function getAttribute($swiss,$attr) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
*$attr | **$attr | ||
===getChildConfigNode()=== | ===getChildConfigNode()=== | ||
*Signature: protected function getChildConfigNode($node,$child) | *Signature: protected function getChildConfigNode($node,$child) | ||
*Parameters: | *Parameters: | ||
*$node | **$node | ||
*$child | **$child | ||
===getChildConfigNodes()=== | ===getChildConfigNodes()=== | ||
*Signature: protected function getChildConfigNodes($swiss,$child) | *Signature: protected function getChildConfigNodes($swiss,$child) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
*$child | **$child | ||
***Default Value: null | ***Default Value: null | ||
===getChildNames()=== | ===getChildNames()=== | ||
*Signature: public function getChildNames($swiss) | *Signature: public function getChildNames($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getChildStorage()=== | ===getChildStorage()=== | ||
*Signature: public function getChildStorage($swiss,$child,$create) | *Signature: public function getChildStorage($swiss,$child,$create) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
*$child | **$child | ||
***Default Value: null | ***Default Value: null | ||
*$create | **$create | ||
***Default Value: false | ***Default Value: false | ||
===getChildType()=== | ===getChildType()=== | ||
*Signature: public function getChildType($swiss,$child) | *Signature: public function getChildType($swiss,$child) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
*$child | **$child | ||
===getConfigNode()=== | ===getConfigNode()=== | ||
*Signature: public function getConfigNode($swiss) | *Signature: public function getConfigNode($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getDescription()=== | ===getDescription()=== | ||
*Signature: public function getDescription($swiss) | *Signature: public function getDescription($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getDisplayName()=== | ===getDisplayName()=== | ||
*Signature: public function getDisplayName($swiss) | *Signature: public function getDisplayName($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getRootStorage()=== | ===getRootStorage()=== | ||
*Signature: protected function getRootStorage() | *Signature: protected function getRootStorage() | ||
| Line 105: | Line 105: | ||
*Signature: public function getStatus($swiss) | *Signature: public function getStatus($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getTranslatedContentAtPath()=== | ===getTranslatedContentAtPath()=== | ||
*Signature: protected function getTranslatedContentAtPath($tag,$path) | *Signature: protected function getTranslatedContentAtPath($tag,$path) | ||
*Parameters: | *Parameters: | ||
*$tag | **$tag | ||
*$path | **$path | ||
===getURLRoot()=== | ===getURLRoot()=== | ||
*Signature: public function getURLRoot($action) | *Signature: public function getURLRoot($action) | ||
*Parameters: | *Parameters: | ||
*$action | **$action | ||
***Default Value: null | ***Default Value: null | ||
===hasAttribute()=== | ===hasAttribute()=== | ||
*Signature: public function hasAttribute($swiss,$attr) | *Signature: public function hasAttribute($swiss,$attr) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
*$attr | **$attr | ||
===key()=== | ===key()=== | ||
*Signature: public function key($swiss) | *Signature: public function key($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===next()=== | ===next()=== | ||
*Signature: public function next($swiss) | *Signature: public function next($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===rewind()=== | ===rewind()=== | ||
*Signature: public function rewind($swiss) | *Signature: public function rewind($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===setupNode()=== | ===setupNode()=== | ||
*Signature: protected function setupNode($path) | *Signature: protected function setupNode($path) | ||
*Parameters: | *Parameters: | ||
*$path | **$path | ||
===valid()=== | ===valid()=== | ||
*Signature: public function valid($swiss) | *Signature: public function valid($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$page=== | ===$page=== | ||
Revision as of 12:10, 17 October 2009
This article desrcibes the class I2CE_SwissConfigFactory.
- Extends the class: I2CE_SwissFactory.
- Location: Part of the module swissConfig in the package I2CE
- Source: Defined in the file modules/SwissFactory/modules/SwissConfig/lib/I2CE_SwissConfigFactory.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissConfigFactory
Variables
$configNodes
@var protected DOMNode $configNode
- Type: protected $configNodes
$statii
- Type: protected $statii
$module
- Type: protected $module
$translatedConfigs
- Type: protected $translatedConfigs
$child_node_cache
- Type: protected $child_node_cache
$child_node_cache_index
- 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
- Signature: public function __construct($page,$options)
- Parameters:
- $page
- $options
- Default Value: array()
count()
- Signature: public function count($swiss)
- Parameters:
- $swiss
displayValues()
- Signature: public function displayValues($contentNode,$path,$transient_options)
- Parameters:
- $contentNode
- $path
- $transient_options
editValues()
- Signature: public function editValues($contentNode,$path,$transient_options)
- Parameters:
- $contentNode
- $path
- $transient_options
ensureIterator()
- Signature: protected function ensureIterator($swiss)
- Parameters:
- $swiss
getAttribute()
- Signature: public function getAttribute($swiss,$attr)
- Parameters:
- $swiss
- $attr
getChildConfigNode()
- Signature: protected function getChildConfigNode($node,$child)
- Parameters:
- $node
- $child
getChildConfigNodes()
- Signature: protected function getChildConfigNodes($swiss,$child)
- Parameters:
- $swiss
- $child
- Default Value: null
getChildNames()
- Signature: public function getChildNames($swiss)
- Parameters:
- $swiss
getChildStorage()
- Signature: public function getChildStorage($swiss,$child,$create)
- Parameters:
- $swiss
- $child
- Default Value: null
- $create
- Default Value: false
getChildType()
- Signature: public function getChildType($swiss,$child)
- Parameters:
- $swiss
- $child
getConfigNode()
- Signature: public function getConfigNode($swiss)
- Parameters:
- $swiss
getDescription()
- Signature: public function getDescription($swiss)
- Parameters:
- $swiss
getDisplayName()
- Signature: public function getDisplayName($swiss)
- Parameters:
- $swiss
getRootStorage()
- Signature: protected function getRootStorage()
getRootType()
- Signature: protected function getRootType()
getStatus()
- Signature: public function getStatus($swiss)
- Parameters:
- $swiss
getTranslatedContentAtPath()
- Signature: protected function getTranslatedContentAtPath($tag,$path)
- Parameters:
- $tag
- $path
getURLRoot()
- Signature: public function getURLRoot($action)
- Parameters:
- $action
- Default Value: null
- $action
hasAttribute()
- Signature: public function hasAttribute($swiss,$attr)
- Parameters:
- $swiss
- $attr
key()
- Signature: public function key($swiss)
- Parameters:
- $swiss
next()
- Signature: public function next($swiss)
- Parameters:
- $swiss
rewind()
- Signature: public function rewind($swiss)
- Parameters:
- $swiss
setupNode()
- Signature: protected function setupNode($path)
- Parameters:
- $path
valid()
- Signature: public function valid($swiss)
- Parameters:
- $swiss
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
