Class: I2CE PageFormBase (Development)

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

This article describes the abstract class I2CE_PageFormBase .

• Extends the class: I2CE_Page.
• Child Classes:
  • I2CE_PageForm
    • iHRIS_PageFormDataElement
    • iHRIS_PageFormDataSet
    • iHRIS_PageViewDHIS
    • I2CE_PageFormLists
      • I2CE_Page_CustomReport_ArchiveMenu
    • iHRIS_Page_SelfService_Apply
    • iHRIS_PageFormParentPerson
      • iHRIS_PageFormContact
      • iHRIS_Page_UserMap
      • iHRIS_PageFormChangePosition
      • iHRIS_PageFormDeparture
      • iHRIS_PageFormMakeOffer
      • iHRIS_PageFormGraduate
    • iHRIS_PageFormPerson
      • iHRIS_PageFormPersonManage
      • iHRIS_PageFormPersonQualify
    • iHRIS_Page_SelfService_Register
    • I2CE_PageForm_UserRequestEmail
    • I2CE_PageFormParentUser
      • iHRIS_PageFormParentUser
    • I2CE_PageFormUser
      • iHRIS_PageFormUser
    • I2CE_PageFormAuto
      • I2CE_PageAutoListEdit
    • I2CE_PageFormParent
    • iHRIS_PageFormSalary
    • iHRIS_PageFormFacilityInstitution
    • iHRIS_PageFormParentTraining
      • iHRIS_PageFormDisciplinaryAction
      • iHRIS_PageFormDisciplinaryReinstate
      • iHRIS_PageFormLicense
      • iHRIS_PageFormRenew
      • iHRIS_PageFormTrainingDisrupt
      • iHRIS_PageFormTrainingResume
    • iHRIS_PageFormTrainingProgram
    • iHRIS_PageForm_Person_Scheduled_Training_Course
    • iHRIS_Page_FormExam
    • iHRIS_PageFormParentTrainingInstitution
    • iHRIS_PageForm_Evaluate_Course_Competencies
  • I2CE_PageFormCSV
    • iHRIS_PageUploadTraining
  • I2CE_PageMultiForm
• Location: Part of the module forms in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/lib/I2CE_PageFormBase.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.1.0

@filesource Class I2CE_PageFormBase

Variables

$editing

A flag to determine if the page is being edited for the dynamic lists.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 38
• Type: protected boolean $editing

$factory

The factory object that creates new instances of forms

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 43
• Type: protected I2CE_FormFactory $factory

$button_templates

An array of the type of button templates to be used for thie page

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 49
• Type: protected array $button_templates

$checked_validation

Flag to see if we already checked validation

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 167
• Type: protected boolean $checked_validation

$usesConfimPage

@var protected boolean $usesConfirmPage

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 393
• Type: protected $usesConfimPage

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_PageFormBase.php on line 61
• Signature: public function __construct($args,$request_remainder,$get,$post)
• Parameters:
  • $args
  • $request_remainder
  • $get
    • Default Value: null
  • $post
    • Default Value: null

action()

Perform the actions of the page. The default method sets up a form object to display the form and confirmation pages for the given object. It handles everything necessary for editing and saving a single object. Some forms may need to override this if the actions are more complex. Or more simple.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 297
• Signature: protected function action()

action_display()

Main action responsible for displaying the forms

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 336
• Signature: protected function action_display()
• Returns: biikeab
  true on success

action_save()

Checks that all forms are valid, and if so performs the save

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 212
• Signature: protected function action_save()

canSave()

Checks to see if the user can perform the save action and that all forms are valid

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 205
• Signature: protected function canSave()
• Returns: boolean

checkActionPermission()

Checks to see if there are any permissions in the page's args for the given action. If so, it evaluates them. If not returns true.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 191
• Signature: protected function checkActionPermission($action)
• Parameters:
  • $action
• Returns: boolean

displayControls()

Display the save or confirm buttons as needed. If the page is a confirmation view then the save / edit button template will be displayed. Otherwise the confirm and return buttons will be shown.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 132
• Signature: protected function displayControls($save,$show_edit)
• Parameters:
  • boolean $save
    Flag to show the save button. (Defaults to false)
    • Default Value: false
  • boolean $show_edit
    (defaults to true) @global array
    • Default Value: true

hasInvalid()

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

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 373
• Signature: abstract public function hasInvalid()
• Returns: boolean

initPage()

Initializes any data for the page

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 278
• Signature: protected function initPage()
• Returns: boolean.
  True on sucess. False on failture

invalidMessage()

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

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 380
• Signature: public function invalidMessage()

isConfirm()

Checks to see if the page is a confirmation page.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 259
• Signature: protected function isConfirm($check_invalid)
• Parameters:
  • $check_invalid
    • Default Value: true
• Returns: boolean

isEdit()

Checks to see if the page is being submitted as an edit operation.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 246
• Signature: protected function isEdit($validate)
• Parameters:
  • boolean $validate
    Flag to also check to be sure the form data is valid.
    • Default Value: true
• Returns: boolean

isEditing()

Check to see if this page is an editing page and already has data populated.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 100
• Signature: final protected function isEditing()
• Returns: boolean;

isSave()

Checks to see if the page is being submitted as a save operation.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 226
• Signature: protected function isSave($check_invalid)
• Parameters:
  • boolean $check_invalid
    • Default Value: true
• Returns: boolean

loadObjects()

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

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 160
• Signature: abstract protected function loadObjects()
• Returns: boolean

save()

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

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 183
• Signature: abstract protected function save()

setDisplayData()

Set the data to be displayed for the outside of the form field elements. Set up the static data to be displayed in the template. The default method doesn't do anything, but sub-classes may need to override this method. *

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 118
• Signature: protected function setDisplayData()

setEditing()

Set this page to be an editing page for the dynamic lists.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 93
• Signature: final protected function setEditing()

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.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 109
• Signature: abstract protected function setForm()

usesConfirmPage()

Set whether or not we use the confirm page when submitting the form

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 398
• Signature: public function usesConfirmPage($val)
• Parameters:
  • boolean $val
    True if we use a confirm page

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.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormBase.php on line 174
• Signature: abstract protected function validate()

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

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

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

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