Class: I2CE FormBrowser (4.0.21)

From IHRIS Wiki
Revision as of 10:33, 27 December 2011 by Litlfred (talk | contribs) (Created page with "{{otherversions|Class: I2CE_FormBrowser}} This article describes the class ''I2CE_FormBrowser'' . *Extends the class: I2CE_Fuzzy. *Location: Part...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_FormBrowser (versions) .


This article describes the class I2CE_FormBrowser .

I2CE_FormBrowser

Variables

$page

.

$template

$formBrowserPrefix

$action

Methods

__construct()

Th constructor

  • Defined in i2ce/modules/Forms/modules/FormBrowser/lib/I2CE_FormBrowser.php on line 49
  • 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: '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).

addChildForms()

Adds any child forms for this form.

  • Defined in i2ce/modules/Forms/modules/FormBrowser/lib/I2CE_FormBrowser.php on line 509
  • Signature: public function addChildForms($detailNode,$formConfig,$formObj)
  • 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)
  • Returns: boolean.
    Return false if none were added, true if child forms were added.

addEditLink()

Add the edit Link @param I2CE_MagicDataNode $formConfig /modules/forms/forms/$formName

addParentLink()

Add the select records.

addRecordSelect()

Add the select records.

addSaveLink()

Add the save Link @param I2CE_MagicDataNode $formConfig /modules/forms/forms/$formName

getFormBrowser()

Create a form browser node and append it to the specifed node @param mixed $appendNode. Either a DOMNode or a string which is the id of a node. We will append the formBrowser to this node.

getLinkChains()

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)

  • Defined in i2ce/modules/Forms/modules/FormBrowser/lib/I2CE_FormBrowser.php on line 156
  • 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 where $fieldName is the name of the field we are adding
    • boolean $even
      (Defaults to false). If true, will add the class 'even' to the created form field nodes.
      • Default Value: 'I2CE_FormField'

showFieldDetailsForRecord()

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_FormBrowser_(4.0.21)&oldid=41467"