Class: I2Ce Page FormDocumentor: Difference between revisions

From IHRIS Wiki
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''I2Ce_Page_FormDocumentor''.
#REDIRECT [[Class: I2Ce_Page_FormDocumentor (4.1.7)]]
*Extends the class: [[Class: I2CE_Page | I2CE_Page]].
*Location: Part of the module [[I2CE Module List#formDocumentor|formDocumentor]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L33 modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 33
*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 &copy; 2007, 2008 IntraHealth International, Inc.
==Variables==
===$form_cache===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L40 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 40
*Type: protected $form_cache
 
===$form_factory===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L44 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 44
*Type: protected [[Class: I2CE_FormFactory | I2CE_FormFactory]] $form_factory
 
===$check_map===
.  True if we should make check mapped fields
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L48 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 48
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $check_map
 
===$field_defs===
of string assocating a short field name to a field class
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L132 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 132
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $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 [[Class: I2CE_Template | ]] and [[Class: I2CE_User | ]] objects and sets up the basic member variables.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L58 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 58
*Signature: public function __construct($args,$request_remainder,$get,$post)
*Parameters:
** [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
**$get
***Default Value: null
**$post
***Default Value: null
===actionCommandLine()===
The business method if this page is called from the commmand line
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L496 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 496
*Signature: protected function actionCommandLine($args,$request_remainder)
*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 ] $request_remainder <br/>the remainder of the request after the page specfication.
===dot()===
Produces  a .dot file for the given forms as a string
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L319 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 319
*Signature: public function dot($forms)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms
===getDisplayName()===
Get the display name for the specified module. strips out Demo/Demonstration language
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L108 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 108
*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 ]
===getModule()===
The site module
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L68 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 68
*Signature: protected function getModule()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getOutputFile()===
Gets the output file with the given extension
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L76 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 76
*Signature: protected function getOutputFile($ext)
*Parameters:
**$ext
===getSchemeDetails()===
Gets a "scheme" used to describe form documentation options.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L122 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 122
*Signature: protected function getSchemeDetails($scheme)
*Parameters:
**$scheme
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getVersion()===
Gets the version of the specified module
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L92 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 92
*Signature: protected function getVersion($module)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $module
*Returns: string;
===reverseFieldDef()===
Look up the short form of a field class from the long form
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L138 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 138
*Signature: protected function reverseFieldDef($field_def)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $field_def <br/>the class of a form field
===text()===
Produces  a .txt file for the given forms as a string
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L157 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 157
*Signature: public function text($forms)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms
===wiki()===
Produces  a wiki page for the given forms as a string
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php#L231 i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php] on line 231
*Signature: public function wiki($forms)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms
==Inherited Methods==
===_flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#_flattenRequestVars() | I2CE_Page->_flattenRequestVars()]]
 
===display()===
This public method is inherited from [[Class: I2CE_Page#display() | I2CE_Page->display()]]
 
===fixupRequestVariables()===
This public method is inherited from [[Class: I2CE_Page#fixupRequestVariables() | I2CE_Page->fixupRequestVariables()]]
 
===flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#flattenRequestVars() | I2CE_Page->flattenRequestVars()]]
 
===get()===
This public method is inherited from [[Class: I2CE_Page#get() | I2CE_Page->get()]]
 
===getAccessedBaseURL()===
This public method is inherited from [[Class: I2CE_Page#getAccessedBaseURL() | I2CE_Page->getAccessedBaseURL()]]
 
===getTemplate()===
This public method is inherited from [[Class: I2CE_Page#getTemplate() | I2CE_Page->getTemplate()]]
 
===getUser()===
This public method is inherited from [[Class: I2CE_Page#getUser() | I2CE_Page->getUser()]]
 
===get_exists()===
This public method is inherited from [[Class: I2CE_Page#get_exists() | I2CE_Page->get_exists()]]
 
===hasPermission()===
This public method is inherited from [[Class: I2CE_Page#hasPermission() | I2CE_Page->hasPermission()]]
 
===isGet()===
This public method is inherited from [[Class: I2CE_Page#isGet() | I2CE_Page->isGet()]]
 
===isPost()===
This public method is inherited from [[Class: I2CE_Page#isPost() | I2CE_Page->isPost()]]
 
===module()===
This public method is inherited from [[Class: I2CE_Page#module() | I2CE_Page->module()]]
 
===page()===
This public method is inherited from [[Class: I2CE_Page#page() | I2CE_Page->page()]]
 
===pageRemainder()===
This public method is inherited from [[Class: I2CE_Page#pageRemainder() | I2CE_Page->pageRemainder()]]
 
===pageRoot()===
This public method is inherited from [[Class: I2CE_Page#pageRoot() | I2CE_Page->pageRoot()]]
 
===post()===
This public method is inherited from [[Class: I2CE_Page#post() | I2CE_Page->post()]]
 
===post_exists()===
This public method is inherited from [[Class: I2CE_Page#post_exists() | I2CE_Page->post_exists()]]
 
===redirect()===
This public method is inherited from [[Class: I2CE_Page#redirect() | I2CE_Page->redirect()]]
 
===request()===
This public method is inherited from [[Class: I2CE_Page#request() | I2CE_Page->request()]]
 
===request_exists()===
This public method is inherited from [[Class: I2CE_Page#request_exists() | I2CE_Page->request_exists()]]
 
===rewrittenURLs()===
This public method is inherited from [[Class: I2CE_Page#rewrittenURLs() | I2CE_Page->rewrittenURLs()]]
 
===session_req()===
This public method is inherited from [[Class: I2CE_Page#session_req() | I2CE_Page->session_req()]]
 
===session_req_exists()===
This public method is inherited from [[Class: I2CE_Page#session_req_exists() | I2CE_Page->session_req_exists()]]
 
===setAccess()===
This public method is inherited from [[Class: I2CE_Page#setAccess() | I2CE_Page->setAccess()]]
 
===setIsPost()===
This public method is inherited from [[Class: I2CE_Page#setIsPost() | I2CE_Page->setIsPost()]]
 
===setRedirect()===
This public method is inherited from [[Class: I2CE_Page#setRedirect() | I2CE_Page->setRedirect()]]
 
===_display()===
This protected method is inherited from [[Class: I2CE_Page#_display() | I2CE_Page->_display()]]
 
===action()===
This protected method is inherited from [[Class: I2CE_Page#action() | I2CE_Page->action()]]
 
===getAccess()===
This protected method is inherited from [[Class: I2CE_Page#getAccess() | I2CE_Page->getAccess()]]
 
===getTitle()===
This protected method is inherited from [[Class: I2CE_Page#getTitle() | I2CE_Page->getTitle()]]
 
===initializeTemplate()===
This protected method is inherited from [[Class: I2CE_Page#initializeTemplate() | I2CE_Page->initializeTemplate()]]
 
===loadHTMLTemplates()===
This protected method is inherited from [[Class: I2CE_Page#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
 
===setupGetPost()===
This protected method is inherited from [[Class: I2CE_Page#setupGetPost() | I2CE_Page->setupGetPost()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
===$template===
Theis protected variable is inherited from [[Class: I2CE_Page#$template | I2CE_Page->$template]]
 
===$defaultHTMLFile===
Theis protected variable is inherited from [[Class: I2CE_Page#$defaultHTMLFile | I2CE_Page->$defaultHTMLFile]]
 
===$role===
Theis protected variable is inherited from [[Class: I2CE_Page#$role | I2CE_Page->$role]]
 
===$user===
Theis protected variable is inherited from [[Class: I2CE_Page#$user | I2CE_Page->$user]]
 
===$post===
Theis protected variable is inherited from [[Class: I2CE_Page#$post | I2CE_Page->$post]]
 
===$get===
Theis protected variable is inherited from [[Class: I2CE_Page#$get | I2CE_Page->$get]]
 
===$page_root===
Theis protected variable is inherited from [[Class: I2CE_Page#$page_root | I2CE_Page->$page_root]]
 
===$page_remainder===
Theis protected variable is inherited from [[Class: I2CE_Page#$page_remainder | I2CE_Page->$page_remainder]]
 
===$args===
Theis protected variable is inherited from [[Class: I2CE_Page#$args | I2CE_Page->$args]]
 
===$request_remainder===
Theis protected variable is inherited from [[Class: I2CE_Page#$request_remainder | I2CE_Page->$request_remainder]]
 
===$permissionParser===
Theis protected variable is inherited from [[Class: I2CE_Page#$permissionParser | I2CE_Page->$permissionParser]]
 
===$page===
Theis protected variable is inherited from [[Class: I2CE_Page#$page | I2CE_Page->$page]]
 
===$module===
Theis protected variable is inherited from [[Class: I2CE_Page#$module | I2CE_Page->$module]]
 
===$is_post===
Theis protected variable is inherited from [[Class: I2CE_Page#$is_post | I2CE_Page->$is_post]]
 
===$session_req===
Theis protected variable is inherited from [[Class: I2CE_Page#$session_req | I2CE_Page->$session_req]]
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]]
 
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]]
 
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]]
 
===addColorPickerTriple()===
This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
 
===selectOptionsImmediate()===
This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]]
 
===setDisplayData()===
This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]]
 
===setDisplayDataImmediate()===
This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]]
 
===addFormWorm()===
This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]]
 
===getClassValue()===
This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]]
 
===loadClassValues()===
This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]]
 
===setClassValue()===
This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]]
 
===setClassValues()===
This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]]
 
===addOption()===
This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]]
 
===addOptions()===
This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]]
 
===addAutoCompleteInputTreeById()===
This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]]
 
===addAutoCompleteInputTree()===
This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]]
 
===setForm()===
This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]]
 
===getField()===
This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]]
 
===setReview()===
This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]]
 
===isReview()===
This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]]
 
===setShowForm()===
This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]]
 
===showForm()===
This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]]
 
===makeJumper()===
This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]]
 
===menuSelect()===
This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]]
 
===addUpdateSelect()===
This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]]
 
===addAjaxUpdate()===
This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
 
===addAjaxToggle()===
This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]]
 
===addAjaxRequestFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]]
 
===addAjaxCompleteFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]]
 
===addAjaxToggleOnFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]]
 
===addAjaxToggleOffFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]]
 
===hasAjax()===
This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]]
 
===setDataTypePriority()===
This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]]
 
===setData()===
This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]]
 
===getData()===
This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]]
 
===getDefaultData()===
This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]]
 
===removeData()===
This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]]
 
===getDataNames()===
This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]]
 
===ensureNode()===
This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 08:53, 23 August 2013