Class: iHRIS PageSearch (Development): Difference between revisions

Latest revision as of 08:30, 6 May 2015

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

This article describes the class iHRIS_PageSearch .

Extends the class: I2CE_Page_ShowReport.
Location: Part of the module ihris-common-Search in the package iHRIS Common 4.1-dev
Source: Defined in the file modules/Search/lib/iHRIS_PageSearch.php on line 30
Author: Carl Leitner <litlfred@ibiblio.org>

Author: Luke Duncan <lduncan@intrahealth.org>

I2CE_Page_ReportRelationship

Methods

action()

Perform any actions for the page

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 117
Signature: public function action()
Returns: boolean.
true on sucess

actionMenu()

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 165
Signature: protected function actionMenu()

actionSearch()

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 242
Signature: protected function actionSearch($view)
Parameters:
- $view

getAllowedDisplays()

Determine all the allowed for the indicated report view

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 49
Signature: public function getAllowedDisplays($view)
Parameters:
- string $view
Returns: array
of string.

getDesiredDisplays()

Determine the desired displays for the indicated report view

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 39
Signature: public function getDesiredDisplays($view)
Parameters:
- string $view
Returns: array
of string.

initPage()

Initializes any data for the page

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 100
Signature: protected function initPage()
Returns: boolean.
True on sucess. False on failture

loadHTMLTemplates()

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

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 86
Signature: protected function loadHTMLTemplates()

setActiveMenu()

Set the active menu

Defined in common/modules/Search/lib/iHRIS_PageSearch.php on line 57
Signature: protected function setActiveMenu()

Inherited Methods

actionCommandLine()

This public method is inherited from I2CE_Page_ShowReport->actionCommandLine()

getDisplay()

This public method is inherited from I2CE_Page_ShowReport->getDisplay()

instantiateDisplay()

This public method is inherited from I2CE_Page_ShowReport->instantiateDisplay()

actionSaveOptions()

This protected method is inherited from I2CE_Page_ShowReport->actionSaveOptions()

actionShow()

This protected method is inherited from I2CE_Page_ShowReport->actionShow()

canViewReport()

This protected method is inherited from I2CE_Page_ShowReport->canViewReport()

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

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

setupGetPost()

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

_hasMethod()

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

Inherited Variables

$displays

Theis protected variable is inherited from I2CE_Page_ShowReport->$displays

$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

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

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

@@ Line 1: / Line 1: @@
 {{otherversions|Class: iHRIS_PageSearch}}
 This article describes the class ''iHRIS_PageSearch'' .
-*Extends the class: [[Class: I2CE_Page (Development) | I2CE_Page]].
+*Extends the class: [[Class: I2CE_Page_ShowReport (Development) | I2CE_Page_ShowReport]].
-*Location: Part of the module [[iHRIS Common Module List (Development)#ihris-common-Search|ihris-common-Search]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.0-dev
+*Location: Part of the module [[iHRIS Common Module List (Development)#ihris-common-Search|ihris-common-Search]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.1-dev
-*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L30 modules/Search/lib/iHRIS_PageSearch.php] on line 30
+*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L30 modules/Search/lib/iHRIS_PageSearch.php] on line 30
 *Author: Carl Leitner <litlfred@ibiblio.org>
@@ Line 11: / Line 11: @@
 ===action()===
 Perform any actions for the page
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L40 common/modules/Search/lib/iHRIS_PageSearch.php] on line 40
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L117 common/modules/Search/lib/iHRIS_PageSearch.php] on line 117
 *Signature: public function action()
 *Returns: boolean.<br/>true on sucess
 ===actionMenu()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L90 common/modules/Search/lib/iHRIS_PageSearch.php] on line 90
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L165 common/modules/Search/lib/iHRIS_PageSearch.php] on line 165
 *Signature: protected function actionMenu()
 ===actionSearch()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L159 common/modules/Search/lib/iHRIS_PageSearch.php] on line 159
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L242 common/modules/Search/lib/iHRIS_PageSearch.php] on line 242
-*Signature: protected function actionSearch()
+*Signature: protected function actionSearch($view)
-===getDisplayObj()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L179 common/modules/Search/lib/iHRIS_PageSearch.php] on line 179
-*Signature: protected function getDisplayObj($request)
 *Parameters:
-**$request
+**$view
+===getAllowedDisplays()===
+Determine all the allowed for the indicated report view
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L49 common/modules/Search/lib/iHRIS_PageSearch.php] on line 49
+*Signature: public function getAllowedDisplays($view)
+*Parameters:
+** [http://www.php.net/manual/en/language.types.string.php string ] $view
+*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string.
+===getDesiredDisplays()===
+Determine the desired displays for the indicated report view
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L39 common/modules/Search/lib/iHRIS_PageSearch.php] on line 39
+*Signature: public function getDesiredDisplays($view)
+*Parameters:
+** [http://www.php.net/manual/en/language.types.string.php string ] $view
+*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string.
+===initPage()===
+Initializes any data for the page
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L100 common/modules/Search/lib/iHRIS_PageSearch.php] on line 100
+*Signature: protected function initPage()
+*Returns: boolean.<br/>True on sucess. False on failture
+===loadHTMLTemplates()===
+Load the  template (HTML or XML) files to the template object.
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L86 common/modules/Search/lib/iHRIS_PageSearch.php] on line 86
+*Signature: protected function loadHTMLTemplates()
+===setActiveMenu()===
+Set the active menu
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Search/lib/iHRIS_PageSearch.php#L57 common/modules/Search/lib/iHRIS_PageSearch.php] on line 57
+*Signature: protected function setActiveMenu()
 ==Inherited Methods==
+===actionCommandLine()===
+This public method is inherited from [[Class: I2CE_Page_ShowReport (Development)#actionCommandLine() | I2CE_Page_ShowReport->actionCommandLine()]]
+===getDisplay()===
+This public method is inherited from [[Class: I2CE_Page_ShowReport (Development)#getDisplay() | I2CE_Page_ShowReport->getDisplay()]]
+===instantiateDisplay()===
+This public method is inherited from [[Class: I2CE_Page_ShowReport (Development)#instantiateDisplay() | I2CE_Page_ShowReport->instantiateDisplay()]]
+===actionSaveOptions()===
+This protected method is inherited from [[Class: I2CE_Page_ShowReport (Development)#actionSaveOptions() | I2CE_Page_ShowReport->actionSaveOptions()]]
+===actionShow()===
+This protected method is inherited from [[Class: I2CE_Page_ShowReport (Development)#actionShow() | I2CE_Page_ShowReport->actionShow()]]
+===canViewReport()===
+This protected method is inherited from [[Class: I2CE_Page_ShowReport (Development)#canViewReport() | I2CE_Page_ShowReport->canViewReport()]]
 ===__construct()===
 This public method is inherited from [[Class: I2CE_Page (Development)#__construct() | I2CE_Page->__construct()]]
@@ Line 49: / Line 91: @@
 ===getTemplate()===
 This public method is inherited from [[Class: I2CE_Page (Development)#getTemplate() | I2CE_Page->getTemplate()]]
+===getTitle()===
+This public method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
+===getURLRoot()===
+This public method is inherited from [[Class: I2CE_Page (Development)#getURLRoot() | I2CE_Page->getURLRoot()]]
 ===getUser()===
@@ Line 113: / Line 161: @@
 This protected method is inherited from [[Class: I2CE_Page (Development)#_display() | I2CE_Page->_display()]]
-===actionCommandLine()===
+===displayCommandLine()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->actionCommandLine()]]
+This protected method is inherited from [[Class: I2CE_Page (Development)#displayCommandLine() | I2CE_Page->displayCommandLine()]]
+===displayWeb()===
+This protected method is inherited from [[Class: I2CE_Page (Development)#displayWeb() | I2CE_Page->displayWeb()]]
 ===getAccess()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#getAccess() | I2CE_Page->getAccess()]]
-===getTitle()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
 ===initializeTemplate()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#initializeTemplate() | I2CE_Page->initializeTemplate()]]
-===loadHTMLTemplates()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
 ===setupGetPost()===
@@ Line 134: / Line 179: @@
 This public method is inherited from [[Class: I2CE_Fuzzy (Development)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
 ==Inherited Variables==
+===$displays===
+Theis protected variable is inherited from [[Class: I2CE_Page_ShowReport (Development)#$displays | I2CE_Page_ShowReport->$displays]]
 ===$template===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$template | I2CE_Page->$template]]
@@ Line 145: / Line 193: @@
 ===$user===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$user | I2CE_Page->$user]]
+===$redirect===
+Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$redirect | I2CE_Page->$redirect]]
 ===$post===
@@ Line 166: / Line 217: @@
 ===$permissionParser===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$permissionParser | I2CE_Page->$permissionParser]]
+===$root_url===
+Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$root_url | I2CE_Page->$root_url]]
 ===$page===
@@ Line 190: / Line 244: @@
 ===addColorPickerTriple()===
 This method is inherited from [[Class: I2CE_Page (Development)#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
+===addReportSelector()===
+This method is inherited from [[Class: I2CE_Page (Development)#addReportSelector() | I2CE_Page->addReportSelector()]]
 ===addDatePicker()===
@@ Line 217: / Line 274: @@
 ===setClassValues()===
 This method is inherited from [[Class: I2CE_Page (Development)#setClassValues() | I2CE_Page->setClassValues()]]
+===useDropDown()===
+This method is inherited from [[Class: I2CE_Page (Development)#useDropDown() | I2CE_Page->useDropDown()]]
 ===addOption()===
@@ Line 232: / Line 292: @@
 ===setForm()===
 This method is inherited from [[Class: I2CE_Page (Development)#setForm() | I2CE_Page->setForm()]]
+===getForm()===
+This method is inherited from [[Class: I2CE_Page (Development)#getForm() | I2CE_Page->getForm()]]
 ===getField()===
@@ Line 241: / Line 304: @@
 ===isReview()===
 This method is inherited from [[Class: I2CE_Page (Development)#isReview() | I2CE_Page->isReview()]]
-===setShowForm()===
-This method is inherited from [[Class: I2CE_Page (Development)#setShowForm() | I2CE_Page->setShowForm()]]
-===showForm()===
-This method is inherited from [[Class: I2CE_Page (Development)#showForm() | I2CE_Page->showForm()]]
 ===makeJumper()===
 This method is inherited from [[Class: I2CE_Page (Development)#makeJumper() | I2CE_Page->makeJumper()]]
+===makeScalingJumper()===
+This method is inherited from [[Class: I2CE_Page (Development)#makeScalingJumper() | I2CE_Page->makeScalingJumper()]]
 ===menuSelect()===
@@ Line 259: / Line 319: @@
 ===addAjaxUpdate()===
 This method is inherited from [[Class: I2CE_Page (Development)#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
+===addAjaxLoad()===
+This method is inherited from [[Class: I2CE_Page (Development)#addAjaxLoad() | I2CE_Page->addAjaxLoad()]]
 ===addAjaxToggle()===

Anonymous

Search