Class: I2CE Swiss FormRelationship (Development): Difference between revisions
(Created page with '{{otherversions|Class: I2CE_Swiss_FormRelationship}} This article describes the class ''I2CE_Swiss_FormRelationship'' . *Extends the class: [[Class: I2CE_Swiss_FormRelationship_B…') |
No edit summary |
||
Line 9: | Line 9: | ||
I2CE_SwissConfig_FormRelationship | I2CE_SwissConfig_FormRelationship | ||
==Methods== | ==Methods== | ||
===displayAncestors()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L177 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 177 | |||
*Signature: protected function displayAncestors($contentNode,$transient_options,$action) | |||
*Parameters: | |||
**$contentNode | |||
**$transient_options | |||
**$action | |||
===displayMetaData()=== | ===displayMetaData()=== | ||
Displays the meta data about this form @param mixed$configPath @param mixed $configPath @param DOMNode $appendNode The page template node from which we wish to add the join menu to | Displays the meta data about this form @param mixed$configPath @param mixed $configPath @param DOMNode $appendNode The page template node from which we wish to add the join menu to | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L225 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 225 | ||
*Signature: protected function displayMetaData($action,$node) | *Signature: protected function displayMetaData($action,$node) | ||
*Parameters: | *Parameters: | ||
Line 18: | Line 25: | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | ||
===displayValues()=== | ===displayValues()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L144 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 144 | ||
*Signature: public function displayValues($contentNode,$transient_options,$action) | *Signature: public function displayValues($contentNode,$transient_options,$action) | ||
*Parameters: | *Parameters: | ||
Line 24: | Line 31: | ||
**$transient_options | **$transient_options | ||
**$action | **$action | ||
===getAncestorFormNames()=== | |||
Gets the ancesestor forms | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L112 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 112 | |||
*Signature: public function getAncestorFormNames($depth) | |||
*Parameters: | |||
**$depth | |||
***Default Value: 0 | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string, the named ancestral forms | |||
===getChildFormNames()=== | |||
Gets the name of all child forms to the specified depth @var int $depth. Defaults to 1 in which case we only get the immediate children | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L91 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 91 | |||
*Signature: public function getChildFormNames($depth) | |||
*Parameters: | |||
**$depth | |||
***Default Value: 1 | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | |||
===getChildType()=== | ===getChildType()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L125 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 125 | ||
*Signature: public function getChildType($child) | *Signature: public function getChildType($child) | ||
*Parameters: | *Parameters: | ||
Line 39: | Line 62: | ||
*Signature: public function getForm() | *Signature: public function getForm() | ||
===getSwissFunctions()=== | ===getSwissFunctions()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L208 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 208 | ||
*Signature: public function getSwissFunctions() | *Signature: public function getSwissFunctions() | ||
===hasFunctions()=== | ===hasFunctions()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L199 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 199 | ||
*Signature: public function hasFunctions() | *Signature: public function hasFunctions() | ||
===manageFunctions()=== | ===manageFunctions()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L186 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 186 | ||
*Signature: protected function manageFunctions($action,$mainNode,$transient_options) | *Signature: protected function manageFunctions($action,$mainNode,$transient_options) | ||
*Parameters: | *Parameters: | ||
Line 72: | Line 95: | ||
**$form | **$form | ||
===showDropEmpty()=== | ===showDropEmpty()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php# | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L138 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 138 | ||
*Signature: protected function showDropEmpty($action,$contentNode) | *Signature: protected function showDropEmpty($action,$contentNode) | ||
*Parameters: | *Parameters: |
Revision as of 07:58, 3 August 2010
This article describes the class I2CE_Swiss_FormRelationship .
- Extends the class: I2CE_Swiss_FormRelationship_Base.
- Child Classes:
- Location: Part of the module formRelationships in the package I2CE 4.0-dev
- Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissConfig_FormRelationship
Methods
displayAncestors()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 177
- Signature: protected function displayAncestors($contentNode,$transient_options,$action)
- Parameters:
- $contentNode
- $transient_options
- $action
displayMetaData()
Displays the meta data about this form @param mixed$configPath @param mixed $configPath @param DOMNode $appendNode The page template node from which we wish to add the join menu to
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 225
- Signature: protected function displayMetaData($action,$node)
- Parameters:
- $action
- $node
- Returns: boolean
true on success
displayValues()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 144
- Signature: public function displayValues($contentNode,$transient_options,$action)
- Parameters:
- $contentNode
- $transient_options
- $action
getAncestorFormNames()
Gets the ancesestor forms
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 112
- Signature: public function getAncestorFormNames($depth)
- Parameters:
- $depth
- Default Value: 0
- $depth
- Returns: array
of string, the named ancestral forms
getChildFormNames()
Gets the name of all child forms to the specified depth @var int $depth. Defaults to 1 in which case we only get the immediate children
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 91
- Signature: public function getChildFormNames($depth)
- Parameters:
- $depth
- Default Value: 1
- $depth
- Returns: array
getChildType()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 125
- Signature: public function getChildType($child)
- Parameters:
- $child
getDescription()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 59
- Signature: public function getDescription()
getDisplayName()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 51
- Signature: public function getDisplayName()
getForm()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 76
- Signature: public function getForm()
getSwissFunctions()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 208
- Signature: public function getSwissFunctions()
hasFunctions()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 199
- Signature: public function hasFunctions()
manageFunctions()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 186
- Signature: protected function manageFunctions($action,$mainNode,$transient_options)
- Parameters:
- $action
- $mainNode
- $transient_options
processValues()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 31
- Signature: public function processValues($vals)
- Parameters:
- $vals
setDescription()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 67
- Signature: public function setDescription($desc)
- Parameters:
- $desc
setDisplayName()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 71
- Signature: public function setDisplayName($displayName)
- Parameters:
- $displayName
setForm()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 80
- Signature: public function setForm($form)
- Parameters:
- $form
showDropEmpty()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php on line 138
- Signature: protected function showDropEmpty($action,$contentNode)
- Parameters:
- $action
- $contentNode
Inherited Methods
displayOptions()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->displayOptions()
getAjaxJSNodes()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getAjaxJSNodes()
getExistingFormNames()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getExistingFormNames()
getExistingSwissForms()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getExistingSwissForms()
getRelationship()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getRelationship()
getRelationshipBase()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getRelationshipBase()
getRelationships()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getRelationships()
getSwissForm()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getSwissForm()
initializeDisplay()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->initializeDisplay()
getAncestorByClass()
This protected method is inherited from I2CE_Swiss_FormRelationship_Base->getAncestorByClass()
__construct()
This public method is inherited from I2CE_Swiss->__construct()
addAjaxLink()
This public method is inherited from I2CE_Swiss->addAjaxLink()
addLink()
This public method is inherited from I2CE_Swiss->addLink()
count()
This public method is inherited from I2CE_Swiss->count()
current()
This public method is inherited from I2CE_Swiss->current()
display()
This public method is inherited from I2CE_Swiss->display()
getAttribute()
This public method is inherited from I2CE_Swiss->getAttribute()
getChild()
This public method is inherited from I2CE_Swiss->getChild()
getChildNames()
This public method is inherited from I2CE_Swiss->getChildNames()
getFactory()
This public method is inherited from I2CE_Swiss->getFactory()
getField()
This public method is inherited from I2CE_Swiss->getField()
getKeys()
This public method is inherited from I2CE_Swiss->getKeys()
getLocale()
This public method is inherited from I2CE_Swiss->getLocale()
getName()
This public method is inherited from I2CE_Swiss->getName()
getPage()
This public method is inherited from I2CE_Swiss->getPage()
getParent()
This public method is inherited from I2CE_Swiss->getParent()
getPath()
This public method is inherited from I2CE_Swiss->getPath()
getStatus()
This public method is inherited from I2CE_Swiss->getStatus()
getStorage()
This public method is inherited from I2CE_Swiss->getStorage()
getURLQueryString()
This public method is inherited from I2CE_Swiss->getURLQueryString()
getURLRoot()
This public method is inherited from I2CE_Swiss->getURLRoot()
hasAttribute()
This public method is inherited from I2CE_Swiss->hasAttribute()
hasField()
This public method is inherited from I2CE_Swiss->hasField()
hasParent()
This public method is inherited from I2CE_Swiss->hasParent()
humanText()
This public method is inherited from I2CE_Swiss->humanText()
key()
This public method is inherited from I2CE_Swiss->key()
next()
This public method is inherited from I2CE_Swiss->next()
postprocessDisplay()
This public method is inherited from I2CE_Swiss->postprocessDisplay()
prefixName()
This public method is inherited from I2CE_Swiss->prefixName()
renameInputs()
This public method is inherited from I2CE_Swiss->renameInputs()
rewind()
This public method is inherited from I2CE_Swiss->rewind()
setField()
This public method is inherited from I2CE_Swiss->setField()
setPage()
This public method is inherited from I2CE_Swiss->setPage()
setTranslatableField()
This public method is inherited from I2CE_Swiss->setTranslatableField()
updateValues()
This public method is inherited from I2CE_Swiss->updateValues()
valid()
This public method is inherited from I2CE_Swiss->valid()
_getChild()
This protected method is inherited from I2CE_Swiss->_getChild()
addAjaxOptionMenu()
This protected method is inherited from I2CE_Swiss->addAjaxOptionMenu()
addOptionMenu()
This protected method is inherited from I2CE_Swiss->addOptionMenu()
changeClassOnNodes()
This protected method is inherited from I2CE_Swiss->changeClassOnNodes()
createIfNotExists()
This protected method is inherited from I2CE_Swiss->createIfNotExists()
validateValues()
This protected method is inherited from I2CE_Swiss->validateValues()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Variables
$swissRelationship
Theis protected variable is inherited from I2CE_Swiss_FormRelationship_Base->$swissRelationship
$swissForms
Theis protected variable is inherited from I2CE_Swiss_FormRelationship_Base->$swissForms
$name
Theis protected variable is inherited from I2CE_Swiss->$name
$path
Theis protected variable is inherited from I2CE_Swiss->$path
$parent
Theis protected variable is inherited from I2CE_Swiss->$parent
$page
Theis protected variable is inherited from I2CE_Swiss->$page
$template
Theis protected variable is inherited from I2CE_Swiss->$template
$children
Theis protected variable is inherited from I2CE_Swiss->$children
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()