Class: I2CE PageForm (Development)

From IHRIS Wiki
Revision as of 08:16, 6 May 2015 by Sovello (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_PageForm (versions) .


This article describes the abstract class I2CE_PageForm .

Handles all page display and operations for forms. This class extends the class and adds some default methods and variables for form templates that will interface with a object to update the database. The loadObjects () method must be overwritten for all objects extending this abstract class. @abstract

Constants

I2CE_PageForm::EDIT_PRIMARY

Constant values for the type of object being set to be edited for this page: Primary 

The primary object is the main object being edited by this page.  There can only be one.

Defined as: 1

I2CE_PageForm::EDIT_PARENT

Constant values for the type of object being set to be edited for this page: Parent 

The parent for the primary and secondary objects being edited by this page.  The can only be one.

Defined as: 2

I2CE_PageForm::EDIT_SECONDARY

Constant values for the type of object being set to be edited for this page: Secondary 

Any secondary objects being edited by this page.  They share the parent of the primary.  Multiple objects
can be added.

Defined as: 3

I2CE_PageForm::EDIT_CHILD

Constant values for the type of object being set to be edited for this page: Children 

Any child objects of the primary object will use this type.  Multiple objects can be added.

Defined as: 4

Variables

$objects

The objects related to this page. Using the PAGE_FORM_EDIT constants to determine the key for the array and the values will either be a or an array of s.

$node_ids

The node id's of objects related to this page.

Methods

__construct()

Create a new instance of a form page. This will call the constructor for all Page objects and then set up some additional member variables for forms. @param string $title The title for this page. @param string $defaultHTMLFile The default HTML file for this page. @param mixed $access The role required to access this page. @param array $files The list of template files to load for this page.

  • Defined in i2ce/modules/Forms/lib/I2CE_PageForm.php on line 83
  • Signature: public function __construct($args,$request_remainder,$get,$post)
  • Parameters:
    • $args
    • $request_remainder
    • $get
      • Default Value: null
    • $post
      • Default Value: null

getChildObjects()

Get the child objects we are editing on the page

getParent()

Return the parent object for this form.

getPrimary()

Return the primary object being edited.

getSecondaryObjects()

Get the objects we are editing on the page

hasInvalid()

Checks to see if any of the forms on this page have invalid messages

invalidMessage()

Add the form_error template to the page if the template is marked as invalid.

loadObjects()

Create and load any necessary objects for this form. This method must be written for each class extending this class.

save()

Save the objects to the database. Save the default object being edited b @global array

setForm()

Set the I2CE_Form object in the page template. This method will pass the edit object to the page template so that it can process all the form variables.

setObject()

Add an object to the objects being edited or displayed by this page.

  • Defined in i2ce/modules/Forms/lib/I2CE_PageForm.php on line 105
  • Signature: final public function setObject($object,$type,$node_id,$set_form)
  • Parameters:
    • I2CE_Form $object
    • integer $type
      The type of object being added from EDIT constants.
      • Default Value: self::EDIT_PRIMARY
    • mixed $node_id
      a tring which gives the node id for which this object applies to. also can be the DOMNode.
      • Default Value: null
    • boolean $set_form
      Set to true to set the form at this point. Defaults to null meaning that it applies to the whole page
      • Default Value: false

validate()

Run the validation methods for all the objects being edited. If this is a form submit then run the validation methods for the default object being edited. The default method calls the  ::validate() validate method on the object.

Inherited Methods

usesConfirmPage()

This public method is inherited from I2CE_PageFormBase->usesConfirmPage()

action()

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

action_display()

This protected method is inherited from I2CE_PageFormBase->action_display()

action_save()

This protected method is inherited from I2CE_PageFormBase->action_save()

canSave()

This protected method is inherited from I2CE_PageFormBase->canSave()

checkActionPermission()

This protected method is inherited from I2CE_PageFormBase->checkActionPermission()

displayControls()

This protected method is inherited from I2CE_PageFormBase->displayControls()

initPage()

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

isConfirm()

This protected method is inherited from I2CE_PageFormBase->isConfirm()

isEdit()

This protected method is inherited from I2CE_PageFormBase->isEdit()

isEditing()

This protected method is inherited from I2CE_PageFormBase->isEditing()

isSave()

This protected method is inherited from I2CE_PageFormBase->isSave()

setDisplayData()

This protected method is inherited from I2CE_PageFormBase->setDisplayData()

setEditing()

This protected method is inherited from I2CE_PageFormBase->setEditing()

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

actionCommandLine()

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

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

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

$editing

Theis protected variable is inherited from I2CE_PageFormBase->$editing

$factory

Theis protected variable is inherited from I2CE_PageFormBase->$factory

$button_templates

Theis protected variable is inherited from I2CE_PageFormBase->$button_templates

$checked_validation

Theis protected variable is inherited from I2CE_PageFormBase->$checked_validation

$usesConfimPage

Theis protected variable is inherited from I2CE_PageFormBase->$usesConfimPage

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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_PageForm_(Development)&oldid=53888"