|
|
| (13 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the ''abstract'' class ''I2CE_SwissFactory''.
| | #REDIRECT [[Class: I2CE_SwissFactory (4.1.7)]] |
| *Child Classes:
| |
| ** [[Class: I2CE_SwissConfigFactory | I2CE_SwissConfigFactory]]
| |
| ** [[Class: I2CE_SwissMagicFactory | I2CE_SwissMagicFactory]]
| |
| *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.1-release/annotate/head:/modules/SwissFactory/lib/I2CE_SwissFactory.php modules/SwissFactory/lib/I2CE_SwissFactory.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_SwissFactory
| |
| ==Variables==
| |
| ===$page===
| |
| *Type: protected $page
| |
| | |
| ===$swiss===
| |
| *Type: protected $swiss
| |
| | |
| ===$stored_options===
| |
| *Type: protected $stored_options
| |
| | |
| ===$template===
| |
| *Type: protected $template
| |
| | |
| ===$style===
| |
| *Type: protected $style
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| construct a swiss swiss factory and create it if it doesn't exist. @throws Exception
| |
| *Signature: public function __construct($page,$init_options)
| |
| *Parameters:
| |
| **$page
| |
| **$init_options
| |
| ***Default Value: array()
| |
| ===count()===
| |
| *Signature: abstract public function count($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===current()===
| |
| *Signature: public function current($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===displayValues()===
| |
| *Signature: public function displayValues($contentNode,$path,$action,$transient_options)
| |
| *Parameters:
| |
| **$contentNode
| |
| **$path
| |
| **$action
| |
| **$transient_options
| |
| ***Default Value: array()
| |
| ===getAttribute()===
| |
| *Signature: public function getAttribute($swiss,$attr)
| |
| *Parameters:
| |
| **$swiss
| |
| **$attr
| |
| ===getChildNames()===
| |
| *Signature: abstract public function getChildNames($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===getChildStorage()===
| |
| *Signature: abstract public function getChildStorage($swiss,$child,$create)
| |
| *Parameters:
| |
| **$swiss
| |
| **$child
| |
| ***Default Value: null
| |
| **$create
| |
| ***Default Value: false
| |
| ===getChildType()===
| |
| *Signature: abstract public function getChildType($swiss,$child)
| |
| *Parameters:
| |
| **$swiss
| |
| **$child
| |
| ===getDescription()===
| |
| *Signature: public function getDescription($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===getDisplayName()===
| |
| *Signature: public function getDisplayName($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===getPage()===
| |
| Get the page
| |
| *Signature: public function getPage()
| |
| *Returns: [[Class: I2CE_Page | I2CE_Page]]
| |
| ===getPath()===
| |
| Gets the string representation of a path
| |
| *Signature: static public function getPath($path,$addComponents)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $path <br/>Either a string or an arrray of path components
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $addComponents <br/>Defaults to null. If a string or an array of path components then it is appended to the path
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getPathComponents()===
| |
| Gets the array representation of the config node path
| |
| *Signature: static public function getPathComponents($path,$addComponents)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $path <br/>Either a string or an arrray of path components
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $addComponents <br/>Defaults to null. If a string or an array of path components then it is appended to the path
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===getRootStorage()===
| |
| *Signature: abstract protected function getRootStorage()
| |
| ===getRootType()===
| |
| *Signature: protected function getRootType()
| |
| ===getStatus()===
| |
| *Signature: abstract public function getStatus($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===getStorage()===
| |
| *Signature: public function getStorage($path,$add_path)
| |
| *Parameters:
| |
| **$path
| |
| **$add_path
| |
| ***Default Value: null
| |
| ===getStoredOptions()===
| |
| *Signature: public function getStoredOptions($key)
| |
| *Parameters:
| |
| **$key
| |
| ***Default Value: null
| |
| ===getSwiss()===
| |
| get the swiss for a path @param mixed $addPath Either a string which is a config node path or an array of additional path components.
| |
| *Signature: public function getSwiss($path,$add_path)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $path <br/>Either a string which is a config node path or an array of path components.
| |
| **$add_path
| |
| ***Default Value: null
| |
| *Returns: [[Class: I2CE_Swiss | I2CE_Swiss]]<br/>or null
| |
| ===getURLQueryString()===
| |
| *Signature: public function getURLQueryString($additional,$remove)
| |
| *Parameters:
| |
| **$additional
| |
| ***Default Value: array()
| |
| **$remove
| |
| ***Default Value: array()
| |
| ===getURLRoot()===
| |
| *Signature: abstract public function getURLRoot($action)
| |
| *Parameters:
| |
| **$action
| |
| ***Default Value: null
| |
| ===hasAttribute()===
| |
| *Signature: public function hasAttribute($swiss,$attr)
| |
| *Parameters:
| |
| **$swiss
| |
| **$attr
| |
| ===humanText()===
| |
| Tries to turn a string (such as a magic data key) into human text @param $text
| |
| *Signature: static public function humanText($text)
| |
| *Parameters:
| |
| **$text
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===key()===
| |
| *Signature: abstract public function key($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===next()===
| |
| *Signature: abstract public function next($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===rewind()===
| |
| *Signature: abstract public function rewind($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| ===setRedirect()===
| |
| *Signature: public function setRedirect($redirect)
| |
| *Parameters:
| |
| **$redirect
| |
| ===setRootSwiss()===
| |
| *Signature: public function setRootSwiss()
| |
| ===setStoredOptions()===
| |
| *Signature: public function setStoredOptions($options)
| |
| *Parameters:
| |
| **$options
| |
| ===setupDisplay()===
| |
| *Signature: protected function setupDisplay($swiss,$action,$contentNode)
| |
| *Parameters:
| |
| **$swiss
| |
| **$action
| |
| **$contentNode
| |
| ===updateValues()===
| |
| *Signature: public function updateValues($vals,$do_redirect,$transact)
| |
| *Parameters:
| |
| **$vals
| |
| **$do_redirect
| |
| ***Default Value: true
| |
| **$transact
| |
| ***Default Value: false
| |
| ===valid()===
| |
| *Signature: abstract public function valid($swiss)
| |
| *Parameters:
| |
| **$swiss
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
