Class: I2CE FormBrowser: Difference between revisions
(Created page with 'This article desrcibes the class '''I2CE_FormBrowser'''which extends the class I2CE_Fuzzy It is contained in the module [[iHRIS Module List#formBrowser|fo…') |
No edit summary |
||
Line 11: | Line 11: | ||
===$page=== | ===$page=== | ||
. | . | ||
*Type: protected I2CE_Page $page | *Type: protected [[Class: I2CE_Page | I2CE_Page]] $page | ||
===$template=== | ===$template=== | ||
Line 30: | Line 30: | ||
*Signature: public function __construct($page,$action,$options) | *Signature: public function __construct($page,$action,$options) | ||
Parameters: | Parameters: | ||
* I2CE_Page $page | * [[Class: I2CE_Page | I2CE_Page]] $page | ||
* [http://www.php.net/manual/en/language.types.string.php string] $action<br/>What action to perform for this form browser. Valid options are 'showForm', 'editForm' and 'saveForm' | * [http://www.php.net/manual/en/language.types.string.php string] $action<br/>What action to perform for this form browser. Valid options are 'showForm', 'editForm' and 'saveForm' | ||
**Default Value: 'showForm' | **Default Value: 'showForm' |
Revision as of 20:59, 16 October 2009
This article desrcibes the class I2CE_FormBrowserwhich extends the class I2CE_Fuzzy It is contained in the module formBrowser in the package I2CE The class is defined in the file: modules/Forms/modules/FormBrowser/lib/I2CE_FormBrowser.php I2CE_FormBrowser @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public
Variables
$page
.
- Type: protected I2CE_Page $page
$template
- Type: protected $template
$formBrowserPrefix
- Type: protected $formBrowserPrefix
$action
- Type: protected $action
Methods
__construct()
Th constructor 'FBPrefix' => The prefix of all id's related to the formBrowser. If not set 'formBrowser' is used. (This enables having ajax functionality for multiple formBrowsers on the same page).
- Signature: public function __construct($page,$action,$options)
Parameters:
- I2CE_Page $page
- string $action
What action to perform for this form browser. Valid options are 'showForm', 'editForm' and 'saveForm'- Default Value: 'showForm'
- array $options
An associatve array. The following keys are recognized:
addChildForms()
Adds any child forms for this form.
- Signature: public function addChildForms($detailNode,$formConfig,$formObj)
- Returns: boolean. Return false if none were added, true if child forms were added.
Parameters:
- domnode $detailNode
The major node which contains the formBrowser we are creating - I2CE_MagicDataNode $formConfig
/modules/forms/forms/$formName - I2CE_Form $formObj
the form object for the form we are displaying ( or null.if we are not looking at a particular record)
addEditLink()
Add the edit Link @param I2CE_MagicDataNode $formConfig /modules/forms/forms/$formName
- Signature: protected function addEditLink($detailNode,$form,$id,$even)
Parameters:
- domnode $detailNode
The major node which contains the formBrowser we are creating - $form
- $id
- boolean $even
If true, makes this have class 'even'
addParentLink()
Add the select records.
- Signature: protected function addParentLink($detailNode,$formConfig,$formObj,$even)
Parameters:
- domnode $detailNode
The major node which contains the formBrowser we are creating - I2CE_MagicDataNode $formConfig
/modules/forms/forms/$formName - I2CE_Form $formObj
the form object for the form we are displaying ( or null.if we are not looking at a particular record) - boolean $even
If true, makes this have class 'even'
addRecordSelect()
Add the select records.
- Signature: protected function addRecordSelect($formConfig,$detailNode,$id)
Parameters:
- I2CE_MagicDataNode $formConfig
/modules/forms/forms/$formName - domnode $detailNode
The major node which contains the formBrowser we are creating - $id
addSaveLink()
Add the save Link @param I2CE_MagicDataNode $formConfig /modules/forms/forms/$formName
- Signature: protected function addSaveLink($detailNode,$form,$id,$even)
Parameters:
- domnode $detailNode
The major node which contains the formBrowser we are creating - $form
- $id
- boolean $even
If true, makes this have class 'even'
getFormBrowser()
Create a form browser node and append it to the specifed node display generic information about the structure of the form. @param mixed $appendNode. Either a DOMNode or a string which is the id of a node. We will append the formBrowser to this node.
- Signature: public function getFormBrowser($form,$id)
Parameters:
- string $form
- integer $id
The record id of the form we wish to browser or an integer < 1 if we wish to
getLinkChains()
- Signature: protected function getLinkChains($fields,$formClassBase)
Parameters:
- $fields
- $formClassBase
showFieldDetails()
Shows details the underlying database information and class information of a form field. Intend to be called when there is no form instance we are going to set (i.e. no id for a record is expected to be give) where $fieldName is the name of the field we are adding
- Signature: protected function showFieldDetails($detailNode,$form,$fieldConfig,$even)
Parameters:
- $detailNode
- string $form
- I2CE_MagicDataNode $fieldConfig
The magic data node /modules/forms/formClasses/$form/fields/$fieldName - boolean $even
(Defaults to false). If true, will add the class 'even' to the created form field nodes.- Default Value: 'I2CE_FormField'
showFieldDetailsForRecord()
- Signature: protected function showFieldDetailsForRecord($detailNode,$formObj,$field,$edit,$even,$chain)
Parameters:
- $detailNode
- $formObj
- $field
- $edit
- $even
- Default Value: false
- $chain
- Default Value: false
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()