Class: I2Ce Page FormDocumentor (Development)

For other versions, see Class: I2Ce_Page_FormDocumentor (versions) .

This article describes the class I2Ce_Page_FormDocumentor .

• Extends the class: I2CE_Page.
• Location: Part of the module formDocumentor in the package I2CE 4.1-dev
• Source: Defined in the file 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 © 2007, 2008 IntraHealth International, Inc.

Variables

$form_cache

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 40
• Type: protected $form_cache

$form_factory

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 44
• Type: protected I2CE_FormFactory $form_factory

$check_map

. True if we should make check mapped fields

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 48
• Type: protected boolean $check_map

$locale

the locale to make the form map in. specify on the command line by --localee=en_US

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 70
• Type: protected string $locale

$field_defs

of string assocating a short field name to a field class

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 140
• 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.

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 58
• 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

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 543
• 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

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 354
• 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

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 116
• Signature: protected function getDisplayName($module)
• Parameters:
  • string $module
• Returns: string

getModule()

The site module

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 76
• Signature: protected function getModule()
• Returns: string

getOutputFile()

Gets the output file with the given extension

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 84
• Signature: protected function getOutputFile($ext)
• Parameters:
  • $ext

getSchemeDetails()

Gets a "scheme" used to describe form documentation options.

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 130
• Signature: protected function getSchemeDetails($scheme)
• Parameters:
  • $scheme
• Returns: array

getVersion()

Gets the version of the specified module

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 100
• Signature: protected function getVersion($module)
• Parameters:
  • string $module
• Returns: string;

reverseFieldDef()

Look up the short form of a field class from the long form

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 146
• 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

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 165
• Signature: public function text($forms)
• Parameters:
  • array $forms
    of string the forms

wiki()

Produces a wiki page for the given forms as a string

• Defined in i2ce/modules/Forms/modules/FormDocumentor/lib/I2CE_Page_FormDocumentor.php on line 243
• Signature: public function wiki($forms)
• Parameters:
  • array $forms
    of string the forms

Inherited Methods

_flattenRequestVars()

This public method is inherited from I2CE_Page->_flattenRequestVars()

display()

This public method is inherited from I2CE_Page->display()

fixupRequestVariables()

This public method is inherited from I2CE_Page->fixupRequestVariables()

flattenRequestVars()

This public method is inherited from I2CE_Page->flattenRequestVars()

get()

This public method is inherited from I2CE_Page->get()

getAccessedBaseURL()

This public method is inherited from I2CE_Page->getAccessedBaseURL()

getTemplate()

This public method is inherited from I2CE_Page->getTemplate()

getTitle()

This public method is inherited from I2CE_Page->getTitle()

getURLRoot()

This public method is inherited from I2CE_Page->getURLRoot()

getUser()

This public method is inherited from I2CE_Page->getUser()

get_exists()

This public method is inherited from I2CE_Page->get_exists()

hasPermission()

This public method is inherited from I2CE_Page->hasPermission()

isGet()

This public method is inherited from I2CE_Page->isGet()

isPost()

This public method is inherited from I2CE_Page->isPost()

module()

This public method is inherited from I2CE_Page->module()

page()

This public method is inherited from I2CE_Page->page()

pageRemainder()

This public method is inherited from I2CE_Page->pageRemainder()

pageRoot()

This public method is inherited from I2CE_Page->pageRoot()

post()

This public method is inherited from I2CE_Page->post()

post_exists()

This public method is inherited from I2CE_Page->post_exists()

redirect()

This public method is inherited from I2CE_Page->redirect()

request()

This public method is inherited from I2CE_Page->request()

request_exists()

This public method is inherited from I2CE_Page->request_exists()

rewrittenURLs()

This public method is inherited from I2CE_Page->rewrittenURLs()

session_req()

This public method is inherited from I2CE_Page->session_req()

session_req_exists()

This public method is inherited from I2CE_Page->session_req_exists()

setAccess()

This public method is inherited from I2CE_Page->setAccess()

setIsPost()

This public method is inherited from I2CE_Page->setIsPost()

setRedirect()

This public method is inherited from I2CE_Page->setRedirect()

_display()

This protected method is inherited from I2CE_Page->_display()

action()

This protected method is inherited from I2CE_Page->action()

displayCommandLine()

This protected method is inherited from I2CE_Page->displayCommandLine()

displayWeb()

This protected method is inherited from I2CE_Page->displayWeb()

getAccess()

This protected method is inherited from I2CE_Page->getAccess()

initPage()

This protected method is inherited from I2CE_Page->initPage()

initializeTemplate()

This protected method is inherited from I2CE_Page->initializeTemplate()

loadHTMLTemplates()

This protected method is inherited from I2CE_Page->loadHTMLTemplates()

setActiveMenu()

This protected method is inherited from I2CE_Page->setActiveMenu()

setupGetPost()

This protected method is inherited from I2CE_Page->setupGetPost()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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

$redirect

Theis protected variable is inherited from I2CE_Page->$redirect

$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

$root_url

Theis protected variable is inherited from I2CE_Page->$root_url

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

addReportSelector()

This method is inherited from I2CE_Page->addReportSelector()

addDatePicker()

This method is inherited from I2CE_Page->addDatePicker()

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

useDropDown()

This method is inherited from I2CE_Page->useDropDown()

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

getForm()

This method is inherited from I2CE_Page->getForm()

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

makeJumper()

This method is inherited from I2CE_Page->makeJumper()

makeScalingJumper()

This method is inherited from I2CE_Page->makeScalingJumper()

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

addAjaxLoad()

This method is inherited from I2CE_Page->addAjaxLoad()

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