Class: I2CE Swiss FormRelationship (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
Line 4: Line 4:
*Child Classes:
*Child Classes:
** [[Class: I2CE_Swiss_FormRelationship_Join (Development) | I2CE_Swiss_FormRelationship_Join]]
** [[Class: I2CE_Swiss_FormRelationship_Join (Development) | I2CE_Swiss_FormRelationship_Join]]
*Location: Part of the module [[I2CE Module List (Development)#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L29 modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 29
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L29 modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 29
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissConfig_FormRelationship
I2CE_SwissConfig_FormRelationship
==Methods==
==Methods==
===displayAncestors()===
===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
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L188 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 188
*Signature: protected function displayAncestors($contentNode,$transient_options,$action)
*Signature: protected function displayAncestors($contentNode,$transient_options,$action)
*Parameters:
*Parameters:
Line 18: Line 18:
===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#L225 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 225
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L259 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 259
*Signature: protected function displayMetaData($action,$node)
*Signature: protected function displayMetaData($action,$node)
*Parameters:
*Parameters:
Line 25: 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#L144 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 144
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L151 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 151
*Signature: public function displayValues($contentNode,$transient_options,$action)
*Signature: public function displayValues($contentNode,$transient_options,$action)
*Parameters:
*Parameters:
Line 33: Line 33:
===getAncestorFormNames()===
===getAncestorFormNames()===
Gets the ancesestor forms
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
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L115 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 115
*Signature: public function getAncestorFormNames($depth)
*Signature: public function getAncestorFormNames($depth)
*Parameters:
*Parameters:
Line 41: Line 41:
===getChildFormNames()===
===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
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
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-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)
*Signature: public function getChildFormNames($depth)
*Parameters:
*Parameters:
Line 48: Line 48:
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
*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#L125 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 125
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L128 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 128
*Signature: public function getChildType($child)
*Signature: public function getChildType($child)
*Parameters:
*Parameters:
**$child  
**$child  
===getDescription()===
===getDescription()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L59 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 59
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L59 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 59
*Signature: public function getDescription()
*Signature: public function getDescription()
===getDisplayName()===
===getDisplayName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L51 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 51
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L51 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 51
*Signature: public function getDisplayName()
*Signature: public function getDisplayName()
===getForm()===
===getForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L76 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 76
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L76 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 76
*Signature: public function getForm()
*Signature: public function getForm()
===getSwissFunctionDependency()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L228 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 228
*Signature: public function getSwissFunctionDependency($function)
*Parameters:
**$function
===getSwissFunctionWalker()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L232 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 232
*Signature: protected function getSwissFunctionWalker($swissFunctions,$function,$dependents)
*Parameters:
**$swissFunctions
**$function
**$dependents
===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#L208 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 208
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L219 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 219
*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#L199 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 199
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L210 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 210
*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#L186 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 186
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L197 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 197
*Signature: protected function manageFunctions($action,$mainNode,$transient_options)
*Signature: protected function manageFunctions($action,$mainNode,$transient_options)
*Parameters:
*Parameters:
Line 75: Line 87:
**$transient_options  
**$transient_options  
===processValues()===
===processValues()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L31 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 31
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L31 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 31
*Signature: public function processValues($vals)
*Signature: public function processValues($vals)
*Parameters:
*Parameters:
**$vals  
**$vals  
===setDescription()===
===setDescription()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L67 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 67
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L67 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 67
*Signature: public function setDescription($desc)
*Signature: public function setDescription($desc)
*Parameters:
*Parameters:
**$desc  
**$desc  
===setDisplayName()===
===setDisplayName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L71 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 71
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L71 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 71
*Signature: public function setDisplayName($displayName)
*Signature: public function setDisplayName($displayName)
*Parameters:
*Parameters:
**$displayName  
**$displayName  
===setForm()===
===setForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L80 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 80
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L80 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 80
*Signature: public function setForm($form)
*Signature: public function setForm($form)
*Parameters:
*Parameters:
**$form  
**$form  
===showDisplayStyle()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L145 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 145
*Signature: protected function showDisplayStyle($action,$contentNode)
*Parameters:
**$action
**$contentNode
===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#L138 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 138
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php#L141 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship.php] on line 141
*Signature: protected function showDropEmpty($action,$contentNode)
*Signature: protected function showDropEmpty($action,$contentNode)
*Parameters:
*Parameters:

Latest revision as of 08:19, 6 May 2015


This article describes the class I2CE_Swiss_FormRelationship .

I2CE_SwissConfig_FormRelationship

Methods

displayAncestors()

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

displayValues()

getAncestorFormNames()

Gets the ancesestor 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

getChildType()

getDescription()

getDisplayName()

getForm()

getSwissFunctionDependency()

getSwissFunctionWalker()

getSwissFunctions()

hasFunctions()

manageFunctions()

processValues()

setDescription()

setDisplayName()

setForm()

showDisplayStyle()

showDropEmpty()

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()