Class: I2CE FormRelationship: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''I2CE_FormRelationship''' | This article desrcibes the class '''I2CE_FormRelationship'''. | ||
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]. | |||
It is contained in the module [[iHRIS Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE] | It is contained in the module [[iHRIS Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 36: | Line 37: | ||
*Signature: public function __construct($relationship,$form_reference,$relationship_base) | *Signature: public function __construct($relationship,$form_reference,$relationship_base) | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $relationship | * [http://www.php.net/manual/en/language.types.string.php string ] $relationship | ||
* [http://www.php.net/manual/en/language.pseudo-types.php callback] $form_reference | * [http://www.php.net/manual/en/language.pseudo-types.php callback ] $form_reference | ||
*$relationship_base | *$relationship_base | ||
===_getLimitingFields()=== | ===_getLimitingFields()=== | ||
| Line 98: | Line 99: | ||
Gets the forms required by the relationship | Gets the forms required by the relationship | ||
*Signature: public function getRequiredForms() | *Signature: public function getRequiredForms() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] of string | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] of string | ||
===isPrimaryFormName()=== | ===isPrimaryFormName()=== | ||
*Signature: public function isPrimaryFormName($formname) | *Signature: public function isPrimaryFormName($formname) | ||
Revision as of 21:25, 16 October 2009
This article desrcibes the class I2CE_FormRelationship.
- 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 @subpackage Core
- Author: Carl Leitner <litlfred@ibiblio.org>
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()
