Class: I2CE Swiss FormRelationship Joins: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
==Methods== | ==Methods== | ||
===displayExistingJoins()=== | ===displayExistingJoins()=== | ||
Displays the existing joined forms | Displays the existing joined forms @param mixed $configPath | ||
@param mixed $configPath | |||
*Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options) | *Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options) | ||
* | *Parameters: | ||
Parameters: | |||
*$action | *$action | ||
*$joins | *$joins | ||
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode | ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode | ||
*$transient_options | *$transient_options | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | |||
===displayJoinMenu()=== | ===displayJoinMenu()=== | ||
Add in the UI to select the joinable forms for the specified form | Add in the UI to select the joinable forms for the specified form | ||
*Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode) | *Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode) | ||
* | *Parameters: | ||
Parameters: | |||
*$action | *$action | ||
*$relatedForms | *$relatedForms | ||
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode | ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | |||
===displayValues()=== | ===displayValues()=== | ||
*Signature: public function displayValues($content_node,$transient_options,$action) | *Signature: public function displayValues($content_node,$transient_options,$action) | ||
Parameters: | *Parameters: | ||
*$content_node | *$content_node | ||
*$transient_options | *$transient_options | ||
| Line 32: | Line 31: | ||
===getChildType()=== | ===getChildType()=== | ||
*Signature: public function getChildType($child) | *Signature: public function getChildType($child) | ||
Parameters: | *Parameters: | ||
*$child | *$child | ||
===getRelatedForms()=== | ===getRelatedForms()=== | ||
Gets the data on forms related to the specified form | Gets the data on forms related to the specified form | ||
*Signature: protected function getRelatedForms() | *Signature: protected function getRelatedForms() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] with four keys: 'child','parent', 'parent_field','child_field' each of which has a value an array. | *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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' | ||
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()=== | ===processValues()=== | ||
Update config for given values | Update config for given values | ||
*Signature: public function processValues($vals) | *Signature: public function processValues($vals) | ||
* | *Parameters: | ||
Parameters: | ** [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 | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$swissRelationship=== | ===$swissRelationship=== | ||
Revision as of 23:41, 16 October 2009
This article desrcibes the class I2CE_Swiss_FormRelationship_Joins.
- Extends the class: I2CE_Swiss_FormRelationship_Base.
- Location: Part of the module formRelationships in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php
- Author: Carl Leitner <litlfred@ibiblio.org>
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
- array $vals
- Returns: true
on sucess
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()
