Class: I2Ce Page FormDocumentor

This article desrcibes the class I2Ce_Page_FormDocumentor.

• 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. @copyright Copyright © 2007, 2008 IntraHealth International, Inc.

• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: 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 I2CE_Template and 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 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()

menuSelect()

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()