Class: I2CE Page (Development)

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

This article describes the class I2CE_Page .

• Extends the class: I2CE_Fuzzy.
• Child Classes:
  • I2CE_Page_BackgroundProcess
  • I2CE_Page_Run_SQL
  • I2CE_Page_BinaryField
  • I2CE_Page_CachedForm
  • I2CE_Page_CustomReports
  • I2CE_FileDump
  • I2CE_PageViewList
    • iHRIS_PageViewList
      • iHRIS_PageViewListQualify
  • I2CE_PageFeedback
  • I2CE_PageForgot
  • I2CE_PageLogin
  • I2CE_PageLogout
  • I2CE_PagePassword
  • iHRIS_PageView
  • I2CE_Page_PrintedForms
  • I2CE_Page_ArchiveReport
  • iHRIS_Page_Person_Accident_History
  • I2CE_PageAdmin
  • iHRIS_Page_Person_Disciplinary_Action_History
  • I2CE_PageFormBrowser
  • I2Ce_Page_FormDocumentor
  • I2CE_PageForm
    • I2CE_PageFormLists
      • I2CE_Page_CustomReport_ArchiveMenu
      • iHRIS_PageFormLists
    • iHRIS_PageFormParentPerson
      • iHRIS_PageFormContact
      • iHRIS_PageFormDeparture
      • iHRIS_PageFormMakeOffer
      • iHRIS_PageFormGraduate
    • iHRIS_PageFormPerson
      • iHRIS_PageFormPersonManage
      • iHRIS_PageFormPersonQualify
    • I2CE_PageFormUser
      • iHRIS_PageFormUser
    • 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_PageFormParentTrainingInstitution
    • iHRIS_PageForm_Evaluate_Course_Competencies
  • iHRIS_PageConfigure
  • iHRIS_PageFieldHistory
  • iHRIS_PageHistory
    • iHRIS_PageHistoryQualify
  • iHRIS_PageIndex
  • iHRIS_PageRecentForm
  • iHRIS_PageSearch
  • iHRIS_PageManage
  • iHRIS_PageViewJob
  • iHRIS_PageViewPosition
  • iHRIS_SalaryHistoryPage
  • iHRIS_PageViewTraining
  • I2CE_Page_LocaleAdmin
  • I2CE_Page_MagicDataBrowser
  • I2CE_Page_MagicDataExport
    • I2CE_Page_Report_MagicDataExport
  • I2Ce_Page_ModDocumentor
  • iHRIS_Page_Person_Competency_Evaluation_History
  • I2CE_Page_Stub
  • I2CE_Page_Stub_Ajax_Test
  • I2CE_Page_SwissConfig
  • I2CE_Page_SwissMagic
  • I2CE_Page_TasksAndRoles
• Location: Part of the module pages in the package I2CE 4.0-dev
• Source: Defined in the file modules/Pages/lib/I2CE_Page.php on line 37

Variables

$template

The template object for handling the HTML templates and data to be displayed.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 42
• Type: protected I2CE_Template $template

$defaultHTMLFile

The default HTML/XML files to be displayed by the template. of string

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 47
• Type: protected array $defaultHTMLFile

$role

The role that can view this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 52
• Type: protected mixed $role

$user

The user viewing this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 57
• Type: protected I2CE_User $user

$access

The access level required for this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 62
• Type: private integer $access

$redirect

A url to redirect to instead of displaying the page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 67
• Type: private string $redirect

$post

Holds a reference to the $_POST array which is a list of all data sent from a form.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 72
• Type: protected array $post

$get

Holds a reference to the $_GET array which is a list of all variables sent in the URL or from a form with an action of "GET."

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 78
• Type: protected array $get

$page_root

the page root -- this is the URL relative to the site base that is used to get to this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 172
• Type: protected string $page_root

$page_remainder

the page remainder -- this is the remainder of the URL relative to the site base that is used to get to this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 192
• Type: protected string $page_remainder

$args

The arguments passed in the constructor. @param protected array $args

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 211
• Type: protected $args

$request_remainder

The remainder of the page request -- everything after (option_module_name/)page_name(/reminder/of/the/request) @param protected array $request_remainder

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 216
• Type: protected $request_remainder

$permissionParser

The permission parser for the user of this page. @param I2CE_PermissionParser $permissionParser

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 221
• Type: protected $permissionParser

$page

. The requested page

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 433
• Type: protected string $page

$module

. The module that contains this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 437
• Type: protected string $module

$is_post

-- true if this page is a post.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 624
• Type: protected boolean $is_post

$session_req

Holds a reference to a session request array if one has been requested and exists in the session.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 760
• Type: protected array $session_req

$request_vars

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 830
• Type: private $request_vars

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/Pages/lib/I2CE_Page.php on line 242
• 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

_display()

Display the template as HTML/XML. Sets the header and displays any buffered warnings/echoed text.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 502
• Signature: protected function _display($supress_output)
• Parameters:
  • $supress_output

_flattenRequestVars()

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 391
• Signature: static public function _flattenRequestVars($vars,$req,$prefix)
• Parameters:
  • $vars
  • &$req
  • $prefix

action()

Perform any actions to load the HTML templates. The default action simply loads all the HTML template files.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 145
• Signature: protected function action()
• Returns: boolean.
  true on sucess

actionCommandLine()

The business method if this page is called from the commmand line

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 570
• Signature: protected function actionCommandLine($args,$request_remainder)
• Parameters:
  • array $args
    the array of unix style command line arguments Arguements are link that in: http://us3.php.net/manual/en/features.commandline.php#78651 If we were called as: index.php --page=/module/page/some/thing/else --long -AB 2 -C -D 'ostrich' --eggs==good Then $request_remainder = array('some','thing','else') and $args = array('long'=>true, 'A'=>true, 'B'=>2, 'C'=>true, 'D'=>'ostrich', 'eggs'=>'good')
  • array $request_remainder
    the remainder of the request after the page specfication.

display()

Calls the appropriate action for the page. Then it Displays or redirects the page as appropriate. This will check to make sure the page can be seen by this user and if not redirect them to an error page. If the redirect variable has been set then the page will be redirected to the new page. Otherwise the  ::display() template display method will be called to output the combined template files to the browser.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 450
• Signature: public function display($supress_output)
• Parameters:
  • boolean $supress_output
    defaults to false. set to true to supress the output of a webpage
    • Default Value: false

fixupRequestVariables()

Applies any transformations (make sure magic quotes is off, nesting, and json decoding) to an array variables @param boolean $transform. Defaults to true

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 362
• Signature: static public function fixupRequestVariables($vars)
• Parameters:
  • array $vars
• Returns: $vars;

flattenRequestVars()

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 384
• Signature: static public function flattenRequestVars($vars)
• Parameters:
  • $vars

get()

Gets/sets the $get value for the given key.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 723
• Signature: public function get($key,$val)
• Parameters:
  • string $key
    Defaults to null meaning we return all of the post variables (it is not slash escaped).
    • Default Value: null
  • mixed $val
    Defaults to null. If non-null we set the post value for $key to $val
    • Default Value: null
• Returns: mixed
  if no val is set: string if a key is given and found. null if key is given nut not found. array otherwise

getAccess()

Get the access level required to view this page. If the access level requirements change after the page object has been instantiated this method is used to set a new access level for the $access variable.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 594
• Signature: protected function getAccess()
• Returns: array
  of string

getAccessedBaseURL()

Returns the base url from which the site was accessed. If no .htaccess is used, ths will include the index.php. If rewrites are used (via .htacces) this will no include the index.php. Point is... this is the base url from which the site was accessed, no questions asked. This of course assumes that you are now accessing the site via the command line

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 93
• Signature: static public function getAccessedBaseURL()
• Returns: string

getTemplate()

Get the template associated to this page

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 163
• Signature: public function getTemplate()

getTitle()

Return the title for this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 156
• Signature: protected function getTitle()
• Returns: string

getUser()

Get the user of this page

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 610
• Signature: public function getUser()
• Returns: I2CE_User

get_exists()

Check to see if a key exists in the $get array.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 702
• Signature: public function get_exists($key)
• Parameters:
  • $key
• Returns: boolean

hasPermission()

Parse a permission string to see if we have permission.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 230
• Signature: public function hasPermission($permission,$node)
• Parameters:
  • string $permission
  • DOMNode $node
    Defaults to null. If set, it is the node in the page's template that we get the data for.
    • Default Value: null
• Returns: boolean.
  Null on failure.

initializeTemplate()

Handles creating hte I2CE_TemplateMeister templates and loading any default templates

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 271
• Signature: protected function initializeTemplate()
• Returns: boolean
  true on success

isGet()

Check to see if the current page is a GET request or not

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 639
• Signature: public function isGet()
• Returns: boolean

isPost()

Check to see if the current page is a POST form submission or not.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 630
• Signature: public function isPost()
• Returns: boolean

loadHTMLTemplates()

Load the template (HTML or XML) files to the template object.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 123
• Signature: protected function loadHTMLTemplates()

module()

Sets/Gets the module.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 409
• Signature: public function module($module)
• Parameters:
  • string $module
    If non-null sets the module's name to $module.
    • Default Value: null
• Returns: string
  if $module was non-null

page()

Sets/Gets the page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 421
• Signature: public function page($page)
• Parameters:
  • string $page
    If non-null sets the page's name to $page.
    • Default Value: null
• Returns: string
  if $page was non-null

pageRemainder()

Get/set the page remainder -- this is the remainder of the URL relative to the site base that is used to get to this page. @param $page_remainder Defaults to null. If non-null we set the page remainder. If null we get the page remainder.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 199
• Signature: public function pageRemainder($page_remainder)
• Parameters:
  • $page_remainder
    • Default Value: null
• Returns: string
  if $page_remainder was null(default)

pageRoot()

Get/set the page root -- this is the URL relative to the site base that is used to get to this page. @param $page_root Defaults to null. If non-null we set the page root. If null we get the page root.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 179
• Signature: public function pageRoot($page_root)
• Parameters:
  • $page_root
    • Default Value: null
• Returns: string
  if $page_root was null(default)

post()

Get/set the $post value for the given key.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 668
• Signature: public function post($key,$val)
• Parameters:
  • string $key
    Defaults to null meaning we return all of the post variables (it is not slash escaped).
    • Default Value: null
  • mixed $val
    Defaults to null. If non-null we set the post value for $key to $val
    • Default Value: null
• Returns: mixed
  if no val is set: string if a key is given and found. null if key is given nut not found. array otherwise

post_exists()

Check to see if a key exists in the $post array.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 647
• Signature: public function post_exists($key)
• Parameters:
  • $key
• Returns: boolean

redirect()

Send the redirect header with the given URL.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 102
• Signature: public function redirect($url)
• Parameters:
  • string $url

request()

Return the given value for the key in one of the request arrays.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 836
• Signature: public function request($key)
• Parameters:
  • mixed $key
    • Default Value: null
• Returns: mixed

request_exists()

Checks all the request arrays for the given key and returns true if it exists.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 824
• Signature: public function request_exists($key)
• Parameters:
  • mixed $key
• Returns: boolean

rewrittenURLs()

returns true if the url's have been written. false if not

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 83
• Signature: static public function rewrittenURLs()

session_req()

Gets/sets the $session_req value for the given key.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 786
• Signature: public function session_req($key,$val)
• Parameters:
  • string $key
    Defaults to null meaning we return all of the post variables (it is not slash escaped).
    • Default Value: null
  • mixed $val
    Defaults to null. If non-null we set the post value for $key to $val
    • Default Value: null
• Returns: mixed
  if no val is set: string if a key is given and found. null if key is given nut not found. array otherwise

session_req_exists()

Check to see if a key exists in the $session_req array.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 765
• Signature: public function session_req_exists($key)
• Parameters:
  • $key
• Returns: boolean

setAccess()

Change the access level required to view this page. If the access level requirements change after the page object has been instantiated this method is used to set a new access level for the $access variable. @param array of string

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 581
• Signature: public function setAccess($access)
• Parameters:
  • $access

setIsPost()

Sets if this pages is a post or not

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 617
• Signature: public function setIsPost($post)
• Parameters:
  • $post

setRedirect()

Set the URL to be redirected to instead of displaying this page.

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 868
• Signature: public function setRedirect($url)
• Parameters:
  • string $url

setupGetPost()

setup of the get and post variables. @param array $psot. If null (default) it will be $_POST if it is a HTTP array request. otherwise it is the empty array

• Defined in i2ce/modules/Pages/lib/I2CE_Page.php on line 311
• Signature: protected function setupGetPost($get,$post,$strip)
• Parameters:
  • array $get
    If null (default) it will be $_GET if it is a HTTP request. otherwise it is the empty array
    • Default Value: null
  • $post
    • Default Value: null
  • boolean $strip
    Defauls to true. If true it will try to strip off magic quotes if they exist for a HTTP request.
    • Default Value: true

Inherited Methods

_hasMethod()

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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

launchBackgroundProcess()

This method is implemented by I2CE_BackgroundProcess->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is implemented by I2CE_BackgroundProcess->launchBackgroundPHPScript()

launchBackgroundPage()

This method is implemented by I2CE_BackgroundProcess->launchBackgroundPage()

addColorPickerTriple()

This method is implemented by I2CE_Module_ColorPicker->addColorPickerTriple()

addDatePicker()

This method is implemented by I2CE_Module_DatePicker->addDatePicker()

selectOptionsImmediate()

This method is implemented by I2CE_DisplayData->selectOptionsImmediate()

setDisplayData()

This method is implemented by I2CE_DisplayData->setDisplayData()

setDisplayDataImmediate()

This method is implemented by I2CE_DisplayData->setDisplayDataImmediate()

addFormWorm()

This method is implemented by I2CE_Module_FormWorm->addFormWorm()

getClassValue()

This method is implemented by I2CE_MootoolsCore->getClassValue()

loadClassValues()

This method is implemented by I2CE_MootoolsCore->loadClassValues()

setClassValue()

This method is implemented by I2CE_MootoolsCore->setClassValue()

setClassValues()

This method is implemented by I2CE_MootoolsCore->setClassValues()

addOption()

This method is implemented by I2CE_Template_Options->addOption()

addOptions()

This method is implemented by I2CE_Template_Options->addOptions()

addAutoCompleteInputTreeById()

This method is implemented by I2CE_Module_TreeSelect->addAutoCompleteInputTreeById()

addAutoCompleteInputTree()

This method is implemented by I2CE_Module_TreeSelect->addAutoCompleteInputTree()

setForm()

This method is implemented by I2CE_Module_Forms->setForm()

getField()

This method is implemented by I2CE_Module_Forms->getField()

setReview()

This method is implemented by I2CE_Module_Forms->setReview()

isReview()

This method is implemented by I2CE_Module_Forms->isReview()

setShowForm()

This method is implemented by I2CE_Module_Forms->setShowForm()

showForm()

This method is implemented by I2CE_Module_Forms->showForm()

makeJumper()

This method is implemented by I2CE_Module_Jumper->makeJumper()

menuSelect()

This method is implemented by I2CE_Module_MenuSelect->menuSelect()

addUpdateSelect()

This method is implemented by I2CE_Module_MenuSelect->addUpdateSelect()

addAjaxUpdate()

This method is implemented by I2CE_Stub->addAjaxUpdate()

addAjaxToggle()

This method is implemented by I2CE_Stub->addAjaxToggle()

addAjaxRequestFunction()

This method is implemented by I2CE_Stub->addAjaxRequestFunction()

addAjaxCompleteFunction()

This method is implemented by I2CE_Stub->addAjaxCompleteFunction()

addAjaxToggleOnFunction()

This method is implemented by I2CE_Stub->addAjaxToggleOnFunction()

addAjaxToggleOffFunction()

This method is implemented by I2CE_Stub->addAjaxToggleOffFunction()

hasAjax()

This method is implemented by I2CE_Stub->hasAjaxFuzzy()

setDataTypePriority()

This method is implemented by I2CE_Module_TemplateData->setDataTypePriority()

setData()

This method is implemented by I2CE_Module_TemplateData->setData()

getData()

This method is implemented by I2CE_Module_TemplateData->getData()

getDefaultData()

This method is implemented by I2CE_Module_TemplateData->getDefaultData()

removeData()

This method is implemented by I2CE_Module_TemplateData->removeData()

getDataNames()

This method is implemented by I2CE_Module_TemplateData->getDataNames()

ensureNode()

This method is implemented by I2CE_Module_TemplateData->ensureNode()