Class: iHRIS PageFormParentTrainingInstitution

From IHRIS Wiki
Revision as of 13:12, 19 October 2009 by Litlfred (talk | contribs)

The class iHRIS_PageFormParentTrainingInstitution contains 2 definitions:

qualify/lib/iHRIS_PageFormParentTrainingInstitution.php

This article describes the class iHRIS_PageFormParentTrainingInstitution.

Manage adding or editing forms associated with a training institution to the database. @copyright Copyright © 2007, 2008 IntraHealth International, Inc.

Variables

$id

The record id number of the object being edited.

  • Type: protected integer $id

$parent_id

The recored if number of the parent of the object being edited

  • Type: protected integer $parent_id

$form_name

The form name being edited by this page.

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)
  • Parameters:
    • array $args
    • array $request_remainder
      The remainder of the request path

displayControls()

Display the save or confirm button templates as needed.

  • Signature: protected function displayControls($save,$show_edit)
  • Parameters:
    • boolean $save
      Flag to show the save button.
      • Default Value: false
    • boolean $show_edit
      (defaults to true)
      • Default Value: true

getForm()

Return the form name for this page. It will be used for the default form template and php page for the form submission.

  • Signature: protected function getForm($html)
  • Parameters:
    • boolean $html
      Set to true if this is to be used for the html template page to load.
      • Default Value: false
  • Returns: string

loadHTMLTemplates()

Load the HTML template files for editing.

  • Signature: protected function loadHTMLTemplates()

loadObjects()

Create and load data for the objects used for this form. Create the list object and if this is a form submission load the data from the form data. It determines the type based on the member variable.

  • Signature: protected function loadObjects()

save()

Override the default save method to redirect back the training institution page.

  • Signature: protected function save()

setDisplayData()

Set the data to be displayed for the page.

  • Signature: protected function setDisplayData()

common/modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php

This article describes the class iHRIS_PageFormParentTrainingInstitution.

Manage adding or editing forms associated with a training institution to the database. @copyright Copyright © 2007, 2008 IntraHealth International, Inc. Page object to handle the adding or editing forms associated with a training institution to the database.

Variables

$id

The record id number of the object being edited.

  • Type: protected integer $id

$parent_id

The recored if number of the parent of the object being edited

  • Type: protected integer $parent_id

$form_name

The form name being edited by this page.

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)
  • Parameters:
    • array $args
    • array $request_remainder
      The remainder of the request path

displayControls()

Display the save or confirm button templates as needed.

  • Signature: protected function displayControls($save,$show_edit)
  • Parameters:
    • boolean $save
      Flag to show the save button.
      • Default Value: false
    • boolean $show_edit
      (defaults to true)
      • Default Value: true

getForm()

Return the form name for this page. It will be used for the default form template and php page for the form submission.

  • Signature: protected function getForm($html)
  • Parameters:
    • boolean $html
      Set to true if this is to be used for the html template page to load.
      • Default Value: false
  • Returns: string

loadHTMLTemplates()

Load the HTML template files for editing.

  • Signature: protected function loadHTMLTemplates()

loadObjects()

Create and load data for the objects used for this form. Create the list object and if this is a form submission load the data from the form data. It determines the type based on the member variable.

  • Signature: protected function loadObjects()

save()

Override the default save method to redirect back the training institution page.

  • Signature: protected function save()

setDisplayData()

Set the data to be displayed for the page.

  • Signature: protected function setDisplayData()