Class: I2Ce Page FormDocumentor: Difference between revisions
No edit summary |
No edit summary |
||
| Line 23: | Line 23: | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance of a page. | Create a new instance of a page. The default constructor should be called by any pages extending this object. It creates the [[Class: I2CE_Template | I2CE_Template]] and [[Class: I2CE_User | I2CE_User]] objects and sets up the basic member variables. | ||
The default constructor should be called by any pages extending this object. It creates the | |||
[[Class: I2CE_Template | I2CE_Template]] and [[Class: I2CE_User | I2CE_User]] objects and sets up the basic member variables. | |||
*Signature: public function __construct($args,$request_remainder,$get,$post) | *Signature: public function __construct($args,$request_remainder,$get,$post) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $args | ** [http://www.php.net/manual/en/language.types.array.php array ] $args | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder<br/>The remainder of the request path | ** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>The remainder of the request path | ||
*$get | *$get | ||
**Default Value: null | ***Default Value: null | ||
*$post | *$post | ||
**Default Value: null | ***Default Value: null | ||
===actionCommandLine()=== | ===actionCommandLine()=== | ||
The business method if this page is called from the commmand line | The business method if this page is called from the commmand line | ||
*Signature: protected function actionCommandLine($args,$request_remainder) | *Signature: protected function actionCommandLine($args,$request_remainder) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $args<br/>the array of unix style command line arguments | ** [http://www.php.net/manual/en/language.types.array.php array ] $args <br/>the array of unix style command line arguments | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder<br/>the remainder of the request after the page specfication. | ** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>the remainder of the request after the page specfication. | ||
===dot()=== | ===dot()=== | ||
Produces a .dot file for the given forms as a string | Produces a .dot file for the given forms as a string | ||
*Signature: public function dot($forms) | *Signature: public function dot($forms) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>of string the forms | ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms | ||
===getDisplayName()=== | ===getDisplayName()=== | ||
Get the display name for the specified module. | Get the display name for the specified module. strips out Demo/Demonstration language | ||
strips out Demo/Demonstration language | |||
*Signature: protected function getDisplayName($module) | *Signature: protected function getDisplayName($module) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $module | |||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===getModule()=== | ===getModule()=== | ||
The site module | The site module | ||
| Line 60: | Line 56: | ||
Gets the output file with the given extension | Gets the output file with the given extension | ||
*Signature: protected function getOutputFile($ext) | *Signature: protected function getOutputFile($ext) | ||
Parameters: | *Parameters: | ||
*$ext | *$ext | ||
===getSchemeDetails()=== | ===getSchemeDetails()=== | ||
Gets a "scheme" used to describe form documentation options. | Gets a "scheme" used to describe form documentation options. | ||
*Signature: protected function getSchemeDetails($scheme) | *Signature: protected function getSchemeDetails($scheme) | ||
*Parameters: | |||
*$scheme | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
===getVersion()=== | ===getVersion()=== | ||
Gets the version of the specified module | Gets the version of the specified module | ||
*Signature: protected function getVersion($module) | *Signature: protected function getVersion($module) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $module | |||
*Returns: string; | *Returns: string; | ||
===reverseFieldDef()=== | ===reverseFieldDef()=== | ||
Look up the short form of a field class from the long form | Look up the short form of a field class from the long form | ||
*Signature: protected function reverseFieldDef($field_def) | *Signature: protected function reverseFieldDef($field_def) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $field_def<br/>the class of a form field | ** [http://www.php.net/manual/en/language.types.string.php string ] $field_def <br/>the class of a form field | ||
===text()=== | ===text()=== | ||
Produces a .txt file for the given forms as a string | Produces a .txt file for the given forms as a string | ||
*Signature: public function text($forms) | *Signature: public function text($forms) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>of string the forms | ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms | ||
===wiki()=== | ===wiki()=== | ||
Produces a wiki page for the given forms as a string | Produces a wiki page for the given forms as a string | ||
*Signature: public function wiki($forms) | *Signature: public function wiki($forms) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>of string the forms | ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$template=== | ===$template=== | ||
Revision as of 23:41, 16 October 2009
This article desrcibes the class I2Ce_Page_FormDocumentor.
- Extends the class: I2CE_Page.
- Location: Part of the module formDocumentor in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: Demo-v2.a
The page wrangler This page loads the main HTML template for the home page of the site. @copyright Copyright © 2007, 2008 IntraHealth International, Inc.
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 I2CE_Template and I2CE_User objects and sets up the basic member variables.
- Signature: public function __construct($args,$request_remainder,$get,$post)
- Parameters:
- $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:
dot()
Produces a .dot file for the given forms as a string
- Signature: public function dot($forms)
- Parameters:
- array $forms
of string the forms
- array $forms
getDisplayName()
Get the display name for the specified module. strips out Demo/Demonstration language
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)
- Parameters:
- $scheme
- Returns: array
getVersion()
Gets the version of the specified module
- Signature: protected function getVersion($module)
- Parameters:
- string $module
- Returns: string;
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
- string $field_def
text()
Produces a .txt file for the given forms as a string
- Signature: public function text($forms)
- Parameters:
- array $forms
of string the forms
- array $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
- array $forms
Inherited Variables
$template
Theis protected variable is inherited from I2CE_Page->$template
$defaultHTMLFile
Theis protected variable is inherited from I2CE_Page->$defaultHTMLFile
$role
Theis protected variable is inherited from I2CE_Page->$role
$user
Theis protected variable is inherited from I2CE_Page->$user
$post
Theis protected variable is inherited from I2CE_Page->$post
$get
Theis protected variable is inherited from I2CE_Page->$get
$page_root
Theis protected variable is inherited from I2CE_Page->$page_root
$page_remainder
Theis protected variable is inherited from I2CE_Page->$page_remainder
$args
Theis protected variable is inherited from I2CE_Page->$args
$request_remainder
Theis protected variable is inherited from I2CE_Page->$request_remainder
$permissionParser
Theis protected variable is inherited from I2CE_Page->$permissionParser
$page
Theis protected variable is inherited from I2CE_Page->$page
$module
Theis protected variable is inherited from I2CE_Page->$module
$is_post
Theis protected variable is inherited from I2CE_Page->$is_post
$session_req
Theis protected variable is inherited from I2CE_Page->$session_req
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()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
