Class: I2Ce Page FormDocumentor: Difference between revisions
(Created page with 'This article desrcibes the class '''I2Ce_Page_FormDocumentor'''which extends the class I2CE_Page It is contained in the module formDocumentor…') |
No edit summary |
||
Line 98: | Line 98: | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]] | This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]] | ||
===launchBackgroundPHPScript()=== | ===launchBackgroundPHPScript()=== | ||
This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]] | This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]] | ||
===launchBackgroundPage()=== | ===launchBackgroundPage()=== | ||
This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]] | This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]] | ||
===addColorPickerTriple()=== | ===addColorPickerTriple()=== | ||
This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]] | This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]] | ||
===selectOptionsImmediate()=== | ===selectOptionsImmediate()=== | ||
This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]] | This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]] | ||
===setDisplayData()=== | ===setDisplayData()=== | ||
This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]] | This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]] | ||
===setDisplayDataImmediate()=== | ===setDisplayDataImmediate()=== | ||
This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]] | This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]] | ||
===addFormWorm()=== | ===addFormWorm()=== | ||
This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]] | This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]] | ||
===getClassValue()=== | ===getClassValue()=== | ||
This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]] | This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]] | ||
===loadClassValues()=== | ===loadClassValues()=== | ||
This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]] | This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]] | ||
===setClassValue()=== | ===setClassValue()=== | ||
This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]] | This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]] | ||
===setClassValues()=== | ===setClassValues()=== | ||
This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]] | This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]] | ||
===addOption()=== | ===addOption()=== | ||
This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]] | This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]] | ||
===addOptions()=== | ===addOptions()=== | ||
This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]] | This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]] | ||
===addAutoCompleteInputTreeById()=== | ===addAutoCompleteInputTreeById()=== | ||
This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]] | This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]] | ||
===addAutoCompleteInputTree()=== | ===addAutoCompleteInputTree()=== | ||
This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]] | This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]] | ||
===setForm()=== | ===setForm()=== | ||
This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]] | This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]] | ||
===getField()=== | ===getField()=== | ||
This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]] | This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]] | ||
===setReview()=== | ===setReview()=== | ||
This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]] | This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]] | ||
===isReview()=== | ===isReview()=== | ||
This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]] | This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]] | ||
===setShowForm()=== | ===setShowForm()=== | ||
This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]] | This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]] | ||
===showForm()=== | ===showForm()=== | ||
This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]] | This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]] | ||
===makeJumper()=== | ===makeJumper()=== | ||
This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]] | This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]] | ||
===menuSelect()=== | ===menuSelect()=== | ||
This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]] | This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]] | ||
===addUpdateSelect()=== | ===addUpdateSelect()=== | ||
This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]] | This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]] | ||
===addAjaxUpdate()=== | ===addAjaxUpdate()=== | ||
This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]] | This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]] | ||
===addAjaxToggle()=== | ===addAjaxToggle()=== | ||
This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]] | This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]] | ||
===addAjaxRequestFunction()=== | ===addAjaxRequestFunction()=== | ||
This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]] | This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]] | ||
===addAjaxCompleteFunction()=== | ===addAjaxCompleteFunction()=== | ||
This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]] | This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]] | ||
===addAjaxToggleOnFunction()=== | ===addAjaxToggleOnFunction()=== | ||
This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]] | This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]] | ||
===addAjaxToggleOffFunction()=== | ===addAjaxToggleOffFunction()=== | ||
This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]] | This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]] | ||
===hasAjax()=== | ===hasAjax()=== | ||
This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]] | This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]] | ||
===setDataTypePriority()=== | ===setDataTypePriority()=== | ||
This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]] | This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]] | ||
===setData()=== | ===setData()=== | ||
This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]] | This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]] | ||
===getData()=== | ===getData()=== | ||
This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]] | This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]] | ||
===getDefaultData()=== | ===getDefaultData()=== | ||
This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]] | This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]] | ||
===removeData()=== | ===removeData()=== | ||
This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]] | This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]] | ||
===getDataNames()=== | ===getDataNames()=== | ||
This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]] | This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]] | ||
===ensureNode()=== | ===ensureNode()=== | ||
This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]] | This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]] |
Revision as of 20:42, 16 October 2009
This article desrcibes the class I2Ce_Page_FormDocumentorwhich extends the class I2CE_Page It is contained in the module formDocumentor in the package I2CE The class is defined in the file: modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php The page wrangler
This page loads the main HTML template for the home page of the site. @package iHRIS @subpackage DemoManage @access public @author Carl Leitner <litlfred@ibiblio.org> @copyright Copyright © 2007, 2008 IntraHealth International, Inc. @since Demo-v2.a @version Demo-v2.a
Variables
$form_cache
- Type: protected $form_cache
$form_factory
- Type: protected I2CE_FormFactory $form_factory
$check_map
. True if we should make check mapped fields
- Type: protected n $check_map
$field_defs
of string assocating a short field name to a field class
- Type: protected y $field_defs
Methods
__construct()
Create a new instance of a page.
The default constructor should be called by any pages extending this object. It creates the {@link I2CE_Template} and {@link I2CE_User} objects and sets up the basic member variables.
- Signature: public function __construct($args,$request_remainder,$get,$post)
Parameters:
- array $args
- array $request_remainder
The remainder of the request path - $get
- Default Value: null
- $post
- Default Value: null
actionCommandLine()
The business method if this page is called from the commmand line
- Signature: protected function actionCommandLine($args,$request_remainder)
Parameters:
- array $args
the array of unix style command line arguments - array $request_remainder
the remainder of the request after the page specfication.
dot()
Produces a .dot file for the given forms as a string
- Signature: public function dot($forms)
Parameters:
- array $forms
of string the forms
getDisplayName()
Get the display name for the specified module. strips out Demo/Demonstration language
- Signature: protected function getDisplayName($module)
- Returns: string
Parameters:
- string $module
getModule()
The site module
- Signature: protected function getModule()
- Returns: string
getOutputFile()
Gets the output file with the given extension
- Signature: protected function getOutputFile($ext)
Parameters:
- $ext
getSchemeDetails()
Gets a "scheme" used to describe form documentation options.
- Signature: protected function getSchemeDetails($scheme)
- Returns: array
Parameters:
- $scheme
getVersion()
Gets the version of the specified module
- Signature: protected function getVersion($module)
- Returns: string;
Parameters:
- string $module
reverseFieldDef()
Look up the short form of a field class from the long form
- Signature: protected function reverseFieldDef($field_def)
Parameters:
- string $field_def
the class of a form field
text()
Produces a .txt file for the given forms as a string
- Signature: public function text($forms)
Parameters:
- array $forms
of string the forms
wiki()
Produces a wiki page for the given forms as a string
- Signature: public function wiki($forms)
Parameters:
- array $forms
of string the forms
Inherited Fuzzy Methods
launchBackgroundProcess()
This method is inherited from I2CE_Page->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is inherited from I2CE_Page->launchBackgroundPHPScript()
launchBackgroundPage()
This method is inherited from I2CE_Page->launchBackgroundPage()
addColorPickerTriple()
This method is inherited from I2CE_Page->addColorPickerTriple()
selectOptionsImmediate()
This method is inherited from I2CE_Page->selectOptionsImmediate()
setDisplayData()
This method is inherited from I2CE_Page->setDisplayData()
setDisplayDataImmediate()
This method is inherited from I2CE_Page->setDisplayDataImmediate()
addFormWorm()
This method is inherited from I2CE_Page->addFormWorm()
getClassValue()
This method is inherited from I2CE_Page->getClassValue()
loadClassValues()
This method is inherited from I2CE_Page->loadClassValues()
setClassValue()
This method is inherited from I2CE_Page->setClassValue()
setClassValues()
This method is inherited from I2CE_Page->setClassValues()
addOption()
This method is inherited from I2CE_Page->addOption()
addOptions()
This method is inherited from I2CE_Page->addOptions()
addAutoCompleteInputTreeById()
This method is inherited from I2CE_Page->addAutoCompleteInputTreeById()
addAutoCompleteInputTree()
This method is inherited from I2CE_Page->addAutoCompleteInputTree()
setForm()
This method is inherited from I2CE_Page->setForm()
getField()
This method is inherited from I2CE_Page->getField()
setReview()
This method is inherited from I2CE_Page->setReview()
isReview()
This method is inherited from I2CE_Page->isReview()
setShowForm()
This method is inherited from I2CE_Page->setShowForm()
showForm()
This method is inherited from I2CE_Page->showForm()
makeJumper()
This method is inherited from I2CE_Page->makeJumper()
This method is inherited from I2CE_Page->menuSelect()
addUpdateSelect()
This method is inherited from I2CE_Page->addUpdateSelect()
addAjaxUpdate()
This method is inherited from I2CE_Page->addAjaxUpdate()
addAjaxToggle()
This method is inherited from I2CE_Page->addAjaxToggle()
addAjaxRequestFunction()
This method is inherited from I2CE_Page->addAjaxRequestFunction()
addAjaxCompleteFunction()
This method is inherited from I2CE_Page->addAjaxCompleteFunction()
addAjaxToggleOnFunction()
This method is inherited from I2CE_Page->addAjaxToggleOnFunction()
addAjaxToggleOffFunction()
This method is inherited from I2CE_Page->addAjaxToggleOffFunction()
hasAjax()
This method is inherited from I2CE_Page->hasAjax()
setDataTypePriority()
This method is inherited from I2CE_Page->setDataTypePriority()
setData()
This method is inherited from I2CE_Page->setData()
getData()
This method is inherited from I2CE_Page->getData()
getDefaultData()
This method is inherited from I2CE_Page->getDefaultData()
removeData()
This method is inherited from I2CE_Page->removeData()
getDataNames()
This method is inherited from I2CE_Page->getDataNames()
ensureNode()
This method is inherited from I2CE_Page->ensureNode()