Class: I2CE Swiss FormRelationship Joins

From IHRIS Wiki
Revision as of 22:25, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class I2CE_Swiss_FormRelationship_Joins.

It is contained in the module formRelationships in the package I2CE

The class is defined in the file: modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php

I2CE_SwissConfig_FormRelationship_Joins @subpackage Core

  • Author: Carl Leitner <litlfred@ibiblio.org>

Methods

displayExistingJoins()

Displays the existing joined forms @param mixed $configPath

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

Parameters:

  • $action
  • $joins
  • DOMNode $contentNode
  • $transient_options

displayJoinMenu()

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

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

Parameters:

  • $action
  • $relatedForms
  • DOMNode $contentNode

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)
  • Returns: true on sucess

Parameters:

  • array $vals
    An array of values (presumably from $_POST) to update magic data from

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Swiss_FormRelationship_Joins&oldid=6612"