Class: I2CE PageLogin (Development): Difference between revisions

Latest revision as of 08:17, 6 May 2015

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

This article describes the class I2CE_PageLogin .

Extends the class: I2CE_Page.
Location: Part of the module LoginPage in the package I2CE 4.1-dev
Source: Defined in the file modules/Pages/modules/Login/lib/I2CE_PageLogin.php on line 33
Author: Luke Duncan <lduncan@intrahealth.org>
Since: v2.0.0

Handles the login procedure for gaining access to the site. The page class for displaying the login page.

Variables

$db

The database object

Defined in i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php on line 38
Type: static protected MDB2 $db

$prepared

The list of prepared statements.

Defined in i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php on line 43
Type: static protected array $prepared

Methods

action()

Perform the main actions of the page. @global array Get the home page from the global configuration

Defined in i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php on line 79
Signature: protected function action()

getHome()

Defined in i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php on line 46
Signature: protected function getHome()

setupDB()

Set up the database and prepared statements if necessary.

Defined in i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php on line 57
Signature: static protected function setupDB()

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

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 2: / Line 2: @@
 This article describes the class ''I2CE_PageLogin'' .
 *Extends the class: [[Class: I2CE_Page (Development) | I2CE_Page]].
-*Location: Part of the module [[I2CE Module List (Development)#LoginPage|LoginPage]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
+*Location: Part of the module [[I2CE Module List (Development)#LoginPage|LoginPage]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
-*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L33 modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 33
+*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L33 modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 33
 *Author: Luke Duncan <lduncan@intrahealth.org>
 *Since: v2.0.0
 Handles the login procedure for gaining access to the site.       The page class for displaying the login page.
+==Variables==
+===$db===
+The database object
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L38 i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 38
+*Type: static protected MDB2 $db
+===$prepared===
+The list of prepared statements.
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L43 i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 43
+*Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $prepared
 ==Methods==
 ===action()===
 Perform the main actions of the page. @global array Get the home page from the global configuration
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L41 i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 41
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L79 i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 79
 *Signature: protected function action()
+===getHome()===
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L46 i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 46
+*Signature: protected function getHome()
+===setupDB()===
+Set up the database and prepared statements if necessary.
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/Login/lib/I2CE_PageLogin.php#L57 i2ce/modules/Pages/modules/Login/lib/I2CE_PageLogin.php] on line 57
+*Signature: static protected function setupDB()
 ==Inherited Methods==
 ===__construct()===
@@ Line 36: / Line 54: @@
 ===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 102: / Line 126: @@
 ===actionCommandLine()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->actionCommandLine()]]
+===displayCommandLine()===
+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()===
+===initPage()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
+This protected method is inherited from [[Class: I2CE_Page (Development)#initPage() | I2CE_Page->initPage()]]
 ===initializeTemplate()===
@@ Line 114: / Line 144: @@
 ===loadHTMLTemplates()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
+===setActiveMenu()===
+This protected method is inherited from [[Class: I2CE_Page (Development)#setActiveMenu() | I2CE_Page->setActiveMenu()]]
 ===setupGetPost()===
@@ Line 132: / Line 165: @@
 ===$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 153: / Line 189: @@
 ===$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 177: / Line 216: @@
 ===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 204: / Line 246: @@
 ===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 219: / Line 264: @@
 ===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 228: / Line 276: @@
 ===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 246: / Line 291: @@
 ===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