Class: I2CE SwissMagicFactory: 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#swissfactory|swissfactory]] in the package [https://launchpad.net/i2ce I2CE] | *Location: Part of the module [[I2CE Module List#swissfactory|swissfactory]] in the package [https://launchpad.net/i2ce I2CE] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L29 modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 29 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
I2CE_SwissMDNFactory | I2CE_SwissMDNFactory | ||
==Variables== | ==Variables== | ||
===$status=== | ===$status=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L31 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 31 | |||
*Type: protected $status | *Type: protected $status | ||
===$root_path=== | ===$root_path=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L32 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 32 | |||
*Type: protected $root_path | *Type: protected $root_path | ||
===$root_type=== | ===$root_type=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L33 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 33 | |||
*Type: protected $root_type | *Type: protected $root_type | ||
===$root_path_create=== | ===$root_path_create=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L34 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 34 | |||
*Type: protected $root_path_create | *Type: protected $root_path_create | ||
===$root_url_postfix=== | ===$root_url_postfix=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L35 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 35 | |||
*Type: protected $root_url_postfix | *Type: protected $root_url_postfix | ||
| Line 24: | Line 29: | ||
===__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 $type. The type of the root swiwss. Defaults to 'Swiss' @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 $type. The type of the root swiwss. Defaults to 'Swiss' @throws Exception | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L43 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 43 | |||
*Signature: public function __construct($page,$init_options) | *Signature: public function __construct($page,$init_options) | ||
*Parameters: | *Parameters: | ||
| Line 30: | Line 36: | ||
***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/lib/I2CE_SwissMagicFactory.php#L189 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 189 | |||
*Signature: public function count($swiss) | *Signature: public function count($swiss) | ||
*Parameters: | *Parameters: | ||
**$swiss | **$swiss | ||
===getChildNames()=== | ===getChildNames()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L94 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 94 | |||
*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/lib/I2CE_SwissMagicFactory.php#L102 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 102 | |||
*Signature: public function getChildStorage($swiss,$child,$create) | *Signature: public function getChildStorage($swiss,$child,$create) | ||
*Parameters: | *Parameters: | ||
| Line 46: | Line 55: | ||
***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/lib/I2CE_SwissMagicFactory.php#L140 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 140 | |||
*Signature: public function getChildType($swiss,$child) | *Signature: public function getChildType($swiss,$child) | ||
*Parameters: | *Parameters: | ||
| Line 51: | Line 61: | ||
**$child | **$child | ||
===getRootStorage()=== | ===getRootStorage()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L76 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 76 | |||
*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/lib/I2CE_SwissMagicFactory.php#L84 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 84 | |||
*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/lib/I2CE_SwissMagicFactory.php#L155 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 155 | |||
*Signature: public function getStatus($swiss) | *Signature: public function getStatus($swiss) | ||
*Parameters: | *Parameters: | ||
**$swiss | **$swiss | ||
===getURLRoot()=== | ===getURLRoot()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L127 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 127 | |||
*Signature: public function getURLRoot($action) | *Signature: public function getURLRoot($action) | ||
*Parameters: | *Parameters: | ||
| Line 64: | Line 78: | ||
***Default Value: null | ***Default Value: null | ||
===key()=== | ===key()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L167 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 167 | |||
*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/lib/I2CE_SwissMagicFactory.php#L171 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 171 | |||
*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/lib/I2CE_SwissMagicFactory.php#L174 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 174 | |||
*Signature: public function rewind($swiss) | *Signature: public function rewind($swiss) | ||
*Parameters: | *Parameters: | ||
**$swiss | **$swiss | ||
===valid()=== | ===valid()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L177 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 177 | |||
*Signature: public function valid($swiss) | *Signature: public function valid($swiss) | ||
*Parameters: | *Parameters: | ||
Revision as of 09:52, 10 November 2009
This article describes the class I2CE_SwissMagicFactory.
- Extends the class: I2CE_SwissFactory.
- Location: Part of the module swissfactory in the package I2CE
- Source: Defined in the file modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissMDNFactory
Variables
$status
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 31
- Type: protected $status
$root_path
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 32
- Type: protected $root_path
$root_type
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 33
- Type: protected $root_type
$root_path_create
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 34
- Type: protected $root_path_create
$root_url_postfix
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 35
- Type: protected $root_url_postfix
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 $type. The type of the root swiwss. Defaults to 'Swiss' @throws Exception
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 43
- Signature: public function __construct($page,$init_options)
- Parameters:
- $page
- $init_options
- Default Value: array()
count()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 189
- Signature: public function count($swiss)
- Parameters:
- $swiss
getChildNames()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 94
- Signature: public function getChildNames($swiss)
- Parameters:
- $swiss
getChildStorage()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 102
- Signature: public function getChildStorage($swiss,$child,$create)
- Parameters:
- $swiss
- $child
- Default Value: null
- $create
- Default Value: false
getChildType()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 140
- Signature: public function getChildType($swiss,$child)
- Parameters:
- $swiss
- $child
getRootStorage()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 76
- Signature: protected function getRootStorage()
getRootType()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 84
- Signature: protected function getRootType()
getStatus()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 155
- Signature: public function getStatus($swiss)
- Parameters:
- $swiss
getURLRoot()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 127
- Signature: public function getURLRoot($action)
- Parameters:
- $action
- Default Value: null
- $action
key()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 167
- Signature: public function key($swiss)
- Parameters:
- $swiss
next()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 171
- Signature: public function next($swiss)
- Parameters:
- $swiss
rewind()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 174
- Signature: public function rewind($swiss)
- Parameters:
- $swiss
valid()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 177
- Signature: public function valid($swiss)
- Parameters:
- $swiss
Inherited Methods
current()
This public method is inherited from I2CE_SwissFactory->current()
displayValues()
This public method is inherited from I2CE_SwissFactory->displayValues()
getAttribute()
This public method is inherited from I2CE_SwissFactory->getAttribute()
getDescription()
This public method is inherited from I2CE_SwissFactory->getDescription()
getDisplayName()
This public method is inherited from I2CE_SwissFactory->getDisplayName()
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()
hasAttribute()
This public method is inherited from I2CE_SwissFactory->hasAttribute()
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
