Class: I2CE FormRelationship

From IHRIS Wiki
Revision as of 15:02, 16 October 2009 by Litlfred (talk | contribs) (Created page with 'This article desrcibes the class '''I2CE_FormRelationship'''which extends the class I2CE_Fuzzy It is contained in the module [[iHRIS Module List#formRelat…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This article desrcibes the class I2CE_FormRelationshipwhich extends the class I2CE_Fuzzy It is contained in the module formRelationships in the package I2CE The class is defined in the file: modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php I2CE_CustomRelationship @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public

Variables

$primaryForm

  • Type: protected $primaryForm

$primaryFormName

  • Type: protected $primaryFormName

$parentFormNames

  • Type: protected $parentFormNames

$formConfigs

  • Type: protected $formConfigs

$relationship

  • Type: protected $relationship

$relConfig

  • Type: protected $relConfig

$form_reference

  • Type: protected $form_reference

$operands

  • Type: static protected $operands

Methods

__construct()

  • Signature: public function __construct($relationship,$form_reference,$relationship_base)

Parameters:

_getLimitingFields()

  • Signature: protected function _getLimitingFields($whereConfig,$limiting_fields)

Parameters:

  • $whereConfig
  • &$limiting_fields

generateWhereClause()

  • Signature: public function generateWhereClause($formName)

Parameters:

  • $formName

getForm()

  • Signature: public function getForm($formname)

Parameters:

  • $formname

getFormConfig()

  • Signature: public function getFormConfig($form)

Parameters:

  • $form
    • Default Value: null

getFormNames()

  • Signature: public function getFormNames()

getForms()

  • Signature: protected function getForms($config,$formConfigs,$parentForms,$parent_form_name)

Parameters:

  • $config
  • &$formConfigs
  • &$parentForms
  • $parent_form_name

getFunctionDetails()

  • Signature: public function getFunctionDetails($function)

Parameters:

  • $function

getJoin()

  • Signature: public function getJoin($formName)

Parameters:

  • $formName

getLimitingFields()

  • Signature: public function getLimitingFields($formName)

Parameters:

  • $formName

getParentFormNames()

  • Signature: public function getParentFormNames($formname)

Parameters:

  • $formname
    • Default Value: null

getPrimaryForm()

  • Signature: public function getPrimaryForm()

getPrimaryFormName()

  • Signature: public function getPrimaryFormName()

getReferencedForm()

  • Signature: public function getReferencedForm($form)

Parameters:

  • $form

getReferenedForm()

  • Signature: public function getReferenedForm($form)

Parameters:

  • $form

getRequiredForms()

Gets the forms required by the relationship

  • Signature: public function getRequiredForms()
  • Returns: array of string

isPrimaryFormName()

  • Signature: public function isPrimaryFormName($formname)

Parameters:

  • $formname

joinOn_child()

  • Signature: protected function joinOn_child($childForm,$joinData)

Parameters:

  • $childForm
  • $joinData

joinOn_child_field()

  • Signature: protected function joinOn_child_field($childForm,$joinData)

Parameters:

  • $childForm
  • $joinData

joinOn_fields()

  • Signature: protected function joinOn_fields($childForm,$joinData)

Parameters:

  • $childForm
  • $joinData

joinOn_ids()

  • Signature: protected function joinOn_ids($childForm,$joinData)

Parameters:

  • $childForm
  • $joinData

joinOn_parent()

  • Signature: protected function joinOn_parent($childForm,$joinData)

Parameters:

  • $childForm
  • $joinData

joinOn_parent_field()

  • Signature: protected function joinOn_parent_field($childForm,$joinData)

Parameters:

  • $childForm
  • $joinData

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()