Class: I2CE SwissMagicFactory: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 26: | Line 26: | ||
*Signature: public function __construct($page,$init_options) | *Signature: public function __construct($page,$init_options) | ||
*Parameters: | *Parameters: | ||
*$page | **$page | ||
*$init_options | **$init_options | ||
***Default Value: array() | ***Default Value: array() | ||
===count()=== | ===count()=== | ||
*Signature: public function count($swiss) | *Signature: public function count($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===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 | ||
===getRootStorage()=== | ===getRootStorage()=== | ||
*Signature: protected function getRootStorage() | *Signature: protected function getRootStorage() | ||
| Line 57: | Line 57: | ||
*Signature: public function getStatus($swiss) | *Signature: public function getStatus($swiss) | ||
*Parameters: | *Parameters: | ||
*$swiss | **$swiss | ||
===getURLRoot()=== | ===getURLRoot()=== | ||
*Signature: public function getURLRoot($action) | *Signature: public function getURLRoot($action) | ||
*Parameters: | *Parameters: | ||
*$action | **$action | ||
***Default Value: null | ***Default Value: null | ||
===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 | ||
===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 13:10, 17 October 2009
This article desrcibes 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
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissMDNFactory
Variables
$status
- Type: protected $status
$root_path
- Type: protected $root_path
$root_type
- Type: protected $root_type
$root_path_create
- Type: protected $root_path_create
$root_url_postfix
- 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
- Signature: public function __construct($page,$init_options)
- Parameters:
- $page
- $init_options
- Default Value: array()
count()
- Signature: public function count($swiss)
- Parameters:
- $swiss
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
getRootStorage()
- Signature: protected function getRootStorage()
getRootType()
- Signature: protected function getRootType()
getStatus()
- Signature: public function getStatus($swiss)
- Parameters:
- $swiss
getURLRoot()
- Signature: public function getURLRoot($action)
- Parameters:
- $action
- Default Value: null
- $action
key()
- Signature: public function key($swiss)
- Parameters:
- $swiss
next()
- Signature: public function next($swiss)
- Parameters:
- $swiss
rewind()
- Signature: public function rewind($swiss)
- Parameters:
- $swiss
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
