Class: I2CE PageReportAction (4.1.7)

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

This article describes the abstract class I2CE_PageReportAction .

• Extends the class: I2CE_Page.
• Child Classes:
  • iHRIS_PageMassDeleteSearchList
  • iHRIS_PageMassDeleteFacilityList
  • iHRIS_PageEditStudents
• Location: Part of the module CustomReports in the package I2CE 4.1.7-release
• Source: Defined in the file modules/CustomReports/lib/I2CE_PageReportAction.php on line 37
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v4.1.3

The page class for working with report actions. @copyright Copyright © 2012 IntraHealth International, Inc. The page class for working with report actions.

Variables

$display

The display for this page.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 42
• Type: protected I2CE_CustomReport_Display_Default_Action $display

Methods

action()

Perform the main actions of the page.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 47
• Signature: protected function action()

actionReport()

Create the report display and add it to the page.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 65
• Signature: protected function actionReport($query)
• Parameters:
  • string $query
    The query string to pass to the action for applying limits.
    • Default Value:
• Returns: boolean

getActionArguments()

Return the arguments to pass to the action method. These arguments should be ready to pass directly to the javascript method so must be quoted and escaped if needed.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 152
• Signature: abstract public function getActionArguments()
• Returns: array

getActionFields()

Return the action fields for this page.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 142
• Signature: public function getActionFields()
• Returns: array

getActionHeader()

Return the action cell header for this page.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 134
• Signature: public function getActionHeader()
• Returns: string

getActionNode()

Return the action node for this page. By default it will create an anchor tag with an onClick method to pass to JavaScript but this can be overridden if necessary on certain pages.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 104
• Signature: public function getActionNode($field_args)
• Parameters:
  • array $field_args
    The arguments to pass to this from the report values.
• Returns: DOMNode

getActionText()

Return the action text to display in each cell based on the fields passed.

• Defined in i2ce/modules/CustomReports/lib/I2CE_PageReportAction.php on line 159
• Signature: abstract public function getActionText($fields)
• Parameters:
  • array $fields
    The field values for this row
• Returns: string

Inherited Methods

__construct()

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

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

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

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