Class: I2CE SwissMagicFactory (Development): Difference between revisions
(Created page with '{{otherversions|Class: I2CE_SwissMagicFactory}} This article describes the class ''I2CE_SwissMagicFactory'' . *Extends the class: [[Class: I2CE_SwissFactory (Development) | I2CE_…') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''I2CE_SwissMagicFactory'' . | This article describes the class ''I2CE_SwissMagicFactory'' . | ||
*Extends the class: [[Class: I2CE_SwissFactory (Development) | I2CE_SwissFactory]]. | *Extends the class: [[Class: I2CE_SwissFactory (Development) | I2CE_SwissFactory]]. | ||
*Location: Part of the module [[I2CE Module List (Development)#swissfactory|swissfactory]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#swissfactory|swissfactory]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 | ||
===$root_url=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L36 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 36 | |||
*Type: protected $root_url | |||
==Methods== | ==Methods== | ||
===__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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L44 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 44 | ||
*Signature: public function __construct($page,$init_options) | *Signature: public function __construct($page,$init_options) | ||
*Parameters: | *Parameters: | ||
Line 37: | Line 41: | ||
***Default Value: array() | ***Default Value: array() | ||
===count()=== | ===count()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L203 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 203 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L100 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 100 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L108 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 108 | ||
*Signature: public function getChildStorage($swiss,$child,$create) | *Signature: public function getChildStorage($swiss,$child,$create) | ||
*Parameters: | *Parameters: | ||
Line 56: | Line 60: | ||
***Default Value: false | ***Default Value: false | ||
===getChildType()=== | ===getChildType()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L154 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 154 | ||
*Signature: public function getChildType($swiss,$child) | *Signature: public function getChildType($swiss,$child) | ||
*Parameters: | *Parameters: | ||
Line 62: | Line 66: | ||
**$child | **$child | ||
===getRootStorage()=== | ===getRootStorage()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L82 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 82 | ||
*Signature: protected function getRootStorage() | *Signature: protected function getRootStorage() | ||
===getRootType()=== | ===getRootType()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L90 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 90 | ||
*Signature: protected function getRootType() | *Signature: protected function getRootType() | ||
===getStatus()=== | ===getStatus()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L169 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 169 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L133 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 133 | ||
*Signature: public function getURLRoot($action) | *Signature: public function getURLRoot($action) | ||
*Parameters: | *Parameters: | ||
Line 79: | Line 83: | ||
***Default Value: null | ***Default Value: null | ||
===key()=== | ===key()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L181 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 181 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L185 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 185 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L188 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 188 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php#L191 i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php] on line 191 | ||
*Signature: public function valid($swiss) | *Signature: public function valid($swiss) | ||
*Parameters: | *Parameters: |
Latest revision as of 09:18, 6 May 2015
This article describes the class I2CE_SwissMagicFactory .
- Extends the class: I2CE_SwissFactory.
- Location: Part of the module swissfactory in the package I2CE 4.1-dev
- 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
$root_url
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 36
- Type: protected $root_url
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 44
- 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 203
- Signature: public function count($swiss)
- Parameters:
- $swiss
getChildNames()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 100
- Signature: public function getChildNames($swiss)
- Parameters:
- $swiss
getChildStorage()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 108
- 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 154
- Signature: public function getChildType($swiss,$child)
- Parameters:
- $swiss
- $child
getRootStorage()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 82
- Signature: protected function getRootStorage()
getRootType()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 90
- Signature: protected function getRootType()
getStatus()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 169
- Signature: public function getStatus($swiss)
- Parameters:
- $swiss
getURLRoot()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 133
- Signature: public function getURLRoot($action)
- Parameters:
- $action
- Default Value: null
- $action
key()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 181
- Signature: public function key($swiss)
- Parameters:
- $swiss
next()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 185
- Signature: public function next($swiss)
- Parameters:
- $swiss
rewind()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 188
- Signature: public function rewind($swiss)
- Parameters:
- $swiss
valid()
- Defined in i2ce/modules/SwissFactory/lib/I2CE_SwissMagicFactory.php on line 191
- 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