Class: I2Ce Page FormDocumentor
This article describes the class I2Ce_Page_FormDocumentor.
- Extends the class: I2CE_Page.
- Parent Classses: I2CE_Page I2CE_Fuzzy
- 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 boolean $check_map
$field_defs
of string assocating a short field name to a field class
- Type: protected 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 and objects and sets up the basic member variables.
- Signature: public function __construct($args,$request_remainder,$get,$post)
- Parameters:
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