Class: I2CE Swiss FormRelationship Joins: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]].
*Extends the class: [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]].
*Parent Classses:  [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]] [[Class: I2CE_Swiss | I2CE_Swiss]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Parent Classses:  [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]] [[Class: I2CE_Swiss | I2CE_Swiss]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Location: Part of the module [[iHRIS Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php]
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
Line 44: Line 44:
** [http://www.php.net/manual/en/language.types.array.php array ] $vals <br/>An array of values (presumably from $_POST) to update magic data from
** [http://www.php.net/manual/en/language.types.array.php array ] $vals <br/>An array of values (presumably from $_POST) to update magic data from
*Returns: true<br/>on sucess
*Returns: true<br/>on sucess
==Inherited Methods==
===displayOptions()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#displayOptions() | I2CE_Swiss_FormRelationship_Base->displayOptions()]]
===getAjaxJSNodes()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getAjaxJSNodes() | I2CE_Swiss_FormRelationship_Base->getAjaxJSNodes()]]
===getExistingFormNames()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getExistingFormNames() | I2CE_Swiss_FormRelationship_Base->getExistingFormNames()]]
===getExistingSwissForms()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getExistingSwissForms() | I2CE_Swiss_FormRelationship_Base->getExistingSwissForms()]]
===getRelationship()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getRelationship() | I2CE_Swiss_FormRelationship_Base->getRelationship()]]
===getRelationshipBase()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getRelationshipBase() | I2CE_Swiss_FormRelationship_Base->getRelationshipBase()]]
===getRelationships()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getRelationships() | I2CE_Swiss_FormRelationship_Base->getRelationships()]]
===getSwissForm()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getSwissForm() | I2CE_Swiss_FormRelationship_Base->getSwissForm()]]
===initializeDisplay()===
This public method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#initializeDisplay() | I2CE_Swiss_FormRelationship_Base->initializeDisplay()]]
===getAncestorByClass()===
This protected method is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#getAncestorByClass() | I2CE_Swiss_FormRelationship_Base->getAncestorByClass()]]
===__construct()===
This public method is inherited from [[Class: I2CE_Swiss#__construct() | I2CE_Swiss->__construct()]]
===addAjaxLink()===
This public method is inherited from [[Class: I2CE_Swiss#addAjaxLink() | I2CE_Swiss->addAjaxLink()]]
===addLink()===
This public method is inherited from [[Class: I2CE_Swiss#addLink() | I2CE_Swiss->addLink()]]
===count()===
This public method is inherited from [[Class: I2CE_Swiss#count() | I2CE_Swiss->count()]]
===current()===
This public method is inherited from [[Class: I2CE_Swiss#current() | I2CE_Swiss->current()]]
===display()===
This public method is inherited from [[Class: I2CE_Swiss#display() | I2CE_Swiss->display()]]
===getAttribute()===
This public method is inherited from [[Class: I2CE_Swiss#getAttribute() | I2CE_Swiss->getAttribute()]]
===getChild()===
This public method is inherited from [[Class: I2CE_Swiss#getChild() | I2CE_Swiss->getChild()]]
===getChildNames()===
This public method is inherited from [[Class: I2CE_Swiss#getChildNames() | I2CE_Swiss->getChildNames()]]
===getDescription()===
This public method is inherited from [[Class: I2CE_Swiss#getDescription() | I2CE_Swiss->getDescription()]]
===getDisplayName()===
This public method is inherited from [[Class: I2CE_Swiss#getDisplayName() | I2CE_Swiss->getDisplayName()]]
===getFactory()===
This public method is inherited from [[Class: I2CE_Swiss#getFactory() | I2CE_Swiss->getFactory()]]
===getField()===
This public method is inherited from [[Class: I2CE_Swiss#getField() | I2CE_Swiss->getField()]]
===getKeys()===
This public method is inherited from [[Class: I2CE_Swiss#getKeys() | I2CE_Swiss->getKeys()]]
===getLocale()===
This public method is inherited from [[Class: I2CE_Swiss#getLocale() | I2CE_Swiss->getLocale()]]
===getName()===
This public method is inherited from [[Class: I2CE_Swiss#getName() | I2CE_Swiss->getName()]]
===getPage()===
This public method is inherited from [[Class: I2CE_Swiss#getPage() | I2CE_Swiss->getPage()]]
===getParent()===
This public method is inherited from [[Class: I2CE_Swiss#getParent() | I2CE_Swiss->getParent()]]
===getPath()===
This public method is inherited from [[Class: I2CE_Swiss#getPath() | I2CE_Swiss->getPath()]]
===getStatus()===
This public method is inherited from [[Class: I2CE_Swiss#getStatus() | I2CE_Swiss->getStatus()]]
===getStorage()===
This public method is inherited from [[Class: I2CE_Swiss#getStorage() | I2CE_Swiss->getStorage()]]
===getURLQueryString()===
This public method is inherited from [[Class: I2CE_Swiss#getURLQueryString() | I2CE_Swiss->getURLQueryString()]]
===getURLRoot()===
This public method is inherited from [[Class: I2CE_Swiss#getURLRoot() | I2CE_Swiss->getURLRoot()]]
===hasAttribute()===
This public method is inherited from [[Class: I2CE_Swiss#hasAttribute() | I2CE_Swiss->hasAttribute()]]
===hasField()===
This public method is inherited from [[Class: I2CE_Swiss#hasField() | I2CE_Swiss->hasField()]]
===hasParent()===
This public method is inherited from [[Class: I2CE_Swiss#hasParent() | I2CE_Swiss->hasParent()]]
===humanText()===
This public method is inherited from [[Class: I2CE_Swiss#humanText() | I2CE_Swiss->humanText()]]
===key()===
This public method is inherited from [[Class: I2CE_Swiss#key() | I2CE_Swiss->key()]]
===next()===
This public method is inherited from [[Class: I2CE_Swiss#next() | I2CE_Swiss->next()]]
===postprocessDisplay()===
This public method is inherited from [[Class: I2CE_Swiss#postprocessDisplay() | I2CE_Swiss->postprocessDisplay()]]
===prefixName()===
This public method is inherited from [[Class: I2CE_Swiss#prefixName() | I2CE_Swiss->prefixName()]]
===renameInputs()===
This public method is inherited from [[Class: I2CE_Swiss#renameInputs() | I2CE_Swiss->renameInputs()]]
===rewind()===
This public method is inherited from [[Class: I2CE_Swiss#rewind() | I2CE_Swiss->rewind()]]
===setField()===
This public method is inherited from [[Class: I2CE_Swiss#setField() | I2CE_Swiss->setField()]]
===setPage()===
This public method is inherited from [[Class: I2CE_Swiss#setPage() | I2CE_Swiss->setPage()]]
===setTranslatableField()===
This public method is inherited from [[Class: I2CE_Swiss#setTranslatableField() | I2CE_Swiss->setTranslatableField()]]
===updateValues()===
This public method is inherited from [[Class: I2CE_Swiss#updateValues() | I2CE_Swiss->updateValues()]]
===valid()===
This public method is inherited from [[Class: I2CE_Swiss#valid() | I2CE_Swiss->valid()]]
===_getChild()===
This protected method is inherited from [[Class: I2CE_Swiss#_getChild() | I2CE_Swiss->_getChild()]]
===addAjaxOptionMenu()===
This protected method is inherited from [[Class: I2CE_Swiss#addAjaxOptionMenu() | I2CE_Swiss->addAjaxOptionMenu()]]
===addOptionMenu()===
This protected method is inherited from [[Class: I2CE_Swiss#addOptionMenu() | I2CE_Swiss->addOptionMenu()]]
===changeClassOnNodes()===
This protected method is inherited from [[Class: I2CE_Swiss#changeClassOnNodes() | I2CE_Swiss->changeClassOnNodes()]]
===createIfNotExists()===
This protected method is inherited from [[Class: I2CE_Swiss#createIfNotExists() | I2CE_Swiss->createIfNotExists()]]
===validateValues()===
This protected method is inherited from [[Class: I2CE_Swiss#validateValues() | I2CE_Swiss->validateValues()]]
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
===$swissRelationship===
Theis protected variable is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#$swissRelationship | I2CE_Swiss_FormRelationship_Base->$swissRelationship]]
===$swissForms===
Theis protected variable is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#$swissForms | I2CE_Swiss_FormRelationship_Base->$swissForms]]
===$name===
Theis protected variable is inherited from [[Class: I2CE_Swiss#$name | I2CE_Swiss->$name]]
===$path===
Theis protected variable is inherited from [[Class: I2CE_Swiss#$path | I2CE_Swiss->$path]]
===$parent===
Theis protected variable is inherited from [[Class: I2CE_Swiss#$parent | I2CE_Swiss->$parent]]
===$page===
Theis protected variable is inherited from [[Class: I2CE_Swiss#$page | I2CE_Swiss->$page]]
===$template===
Theis protected variable is inherited from [[Class: I2CE_Swiss#$template | I2CE_Swiss->$template]]
===$children===
Theis protected variable is inherited from [[Class: I2CE_Swiss#$children | I2CE_Swiss->$children]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]




[[Category:Class Documentation]]
[[Category:Class Documentation]]

Revision as of 13:11, 19 October 2009

This article describes the class I2CE_Swiss_FormRelationship_Joins.

I2CE_SwissConfig_FormRelationship_Joins

Methods

displayExistingJoins()

Displays the existing joined forms @param mixed $configPath

  • Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options)
  • Parameters:
    • $action
    • $joins
    • DOMNode $contentNode
    • $transient_options
  • Returns: boolean
    true on success

displayJoinMenu()

Add in the UI to select the joinable forms for the specified form

  • Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode)
  • Parameters:
    • $action
    • $relatedForms
    • DOMNode $contentNode
  • Returns: boolean
    true on success

displayValues()

  • Signature: public function displayValues($content_node,$transient_options,$action)
  • Parameters:
    • $content_node
    • $transient_options
    • $action

getChildType()

  • Signature: public function getChildType($child)
  • Parameters:
    • $child

getRelatedForms()

Gets the data on forms related to the specified form

  • Signature: protected function getRelatedForms()
  • Returns: array
    with four keys: 'child','parent', 'parent_field','child_field' each of which has a value an array. the first two have arrays with keys forms and value 'true'. The later two have arrays with keys forms and value an array with keys 'field' and 'formClass'

processValues()

Update config for given values

  • Signature: public function processValues($vals)
  • Parameters:
    • array $vals
      An array of values (presumably from $_POST) to update magic data from
  • Returns: true
    on sucess
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Swiss_FormRelationship_Joins&oldid=9733"