|
|
| (15 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]].
| |
| *Parent Classses: [[Class: I2CE_Page | I2CE_Page]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *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.0-release/annotate/head:/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php 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 [[Class: I2CE_FormFactory | I2CE_FormFactory]] $form_factory
| |
| | |
| ===$check_map===
| |
| . True if we should make check mapped fields
| |
| *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
| |
| *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.
| |
| *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
| |
| *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
| |
| *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
| |
| *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
| |
| *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
| |
| *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: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===getVersion()===
| |
| Gets the version of the specified module
| |
| *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
| |
| *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
| |
| *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
| |
| *Signature: public function wiki($forms)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of string the forms
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
