Class: I2CE FormRelationship: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 33: | Line 33: | ||
===__construct()=== | ===__construct()=== | ||
*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()=== | ||
*Signature: protected function _getLimitingFields($whereConfig,$limiting_fields) | *Signature: protected function _getLimitingFields($whereConfig,$limiting_fields) | ||
Parameters: | *Parameters: | ||
*$whereConfig | *$whereConfig | ||
*&$limiting_fields | **&$limiting_fields | ||
===generateWhereClause()=== | ===generateWhereClause()=== | ||
*Signature: public function generateWhereClause($formName) | *Signature: public function generateWhereClause($formName) | ||
Parameters: | *Parameters: | ||
*$formName | *$formName | ||
===getForm()=== | ===getForm()=== | ||
*Signature: public function getForm($formname) | *Signature: public function getForm($formname) | ||
Parameters: | *Parameters: | ||
*$formname | *$formname | ||
===getFormConfig()=== | ===getFormConfig()=== | ||
*Signature: public function getFormConfig($form) | *Signature: public function getFormConfig($form) | ||
Parameters: | *Parameters: | ||
*$form | *$form | ||
**Default Value: null | ***Default Value: null | ||
===getFormNames()=== | ===getFormNames()=== | ||
*Signature: public function getFormNames() | *Signature: public function getFormNames() | ||
===getForms()=== | ===getForms()=== | ||
*Signature: protected function getForms($config,$formConfigs,$parentForms,$parent_form_name) | *Signature: protected function getForms($config,$formConfigs,$parentForms,$parent_form_name) | ||
Parameters: | *Parameters: | ||
*$config | *$config | ||
*&$formConfigs | **&$formConfigs | ||
*&$parentForms | **&$parentForms | ||
*$parent_form_name | *$parent_form_name | ||
===getFunctionDetails()=== | ===getFunctionDetails()=== | ||
*Signature: public function getFunctionDetails($function) | *Signature: public function getFunctionDetails($function) | ||
Parameters: | *Parameters: | ||
*$function | *$function | ||
===getJoin()=== | ===getJoin()=== | ||
*Signature: public function getJoin($formName) | *Signature: public function getJoin($formName) | ||
Parameters: | *Parameters: | ||
*$formName | *$formName | ||
===getLimitingFields()=== | ===getLimitingFields()=== | ||
*Signature: public function getLimitingFields($formName) | *Signature: public function getLimitingFields($formName) | ||
Parameters: | *Parameters: | ||
*$formName | *$formName | ||
===getParentFormNames()=== | ===getParentFormNames()=== | ||
*Signature: public function getParentFormNames($formname) | *Signature: public function getParentFormNames($formname) | ||
Parameters: | *Parameters: | ||
*$formname | *$formname | ||
**Default Value: null | ***Default Value: null | ||
===getPrimaryForm()=== | ===getPrimaryForm()=== | ||
*Signature: public function getPrimaryForm() | *Signature: public function getPrimaryForm() | ||
| Line 87: | Line 87: | ||
===getReferencedForm()=== | ===getReferencedForm()=== | ||
*Signature: public function getReferencedForm($form) | *Signature: public function getReferencedForm($form) | ||
Parameters: | *Parameters: | ||
*$form | *$form | ||
===getReferenedForm()=== | ===getReferenedForm()=== | ||
*Signature: public function getReferenedForm($form) | *Signature: public function getReferenedForm($form) | ||
Parameters: | *Parameters: | ||
*$form | *$form | ||
===getRequiredForms()=== | ===getRequiredForms()=== | ||
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 ]<br/>of string | ||
===isPrimaryFormName()=== | ===isPrimaryFormName()=== | ||
*Signature: public function isPrimaryFormName($formname) | *Signature: public function isPrimaryFormName($formname) | ||
Parameters: | *Parameters: | ||
*$formname | *$formname | ||
===joinOn_child()=== | ===joinOn_child()=== | ||
*Signature: protected function joinOn_child($childForm,$joinData) | *Signature: protected function joinOn_child($childForm,$joinData) | ||
Parameters: | *Parameters: | ||
*$childForm | *$childForm | ||
*$joinData | *$joinData | ||
===joinOn_child_field()=== | ===joinOn_child_field()=== | ||
*Signature: protected function joinOn_child_field($childForm,$joinData) | *Signature: protected function joinOn_child_field($childForm,$joinData) | ||
Parameters: | *Parameters: | ||
*$childForm | *$childForm | ||
*$joinData | *$joinData | ||
===joinOn_fields()=== | ===joinOn_fields()=== | ||
*Signature: protected function joinOn_fields($childForm,$joinData) | *Signature: protected function joinOn_fields($childForm,$joinData) | ||
Parameters: | *Parameters: | ||
*$childForm | *$childForm | ||
*$joinData | *$joinData | ||
===joinOn_ids()=== | ===joinOn_ids()=== | ||
*Signature: protected function joinOn_ids($childForm,$joinData) | *Signature: protected function joinOn_ids($childForm,$joinData) | ||
Parameters: | *Parameters: | ||
*$childForm | *$childForm | ||
*$joinData | *$joinData | ||
===joinOn_parent()=== | ===joinOn_parent()=== | ||
*Signature: protected function joinOn_parent($childForm,$joinData) | *Signature: protected function joinOn_parent($childForm,$joinData) | ||
Parameters: | *Parameters: | ||
*$childForm | *$childForm | ||
*$joinData | *$joinData | ||
===joinOn_parent_field()=== | ===joinOn_parent_field()=== | ||
*Signature: protected function joinOn_parent_field($childForm,$joinData) | *Signature: protected function joinOn_parent_field($childForm,$joinData) | ||
Parameters: | *Parameters: | ||
*$childForm | *$childForm | ||
*$joinData | *$joinData | ||
Revision as of 22:41, 16 October 2009
This article desrcibes the class I2CE_FormRelationship.
- Extends the class: I2CE_Fuzzy.
- Location: Part of the module formRelationships in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_CustomRelationship
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:
- $relationship_base
_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()
