Class: I2CE PageAdmin: Difference between revisions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_Page | I2CE_Page]]. | *Extends the class: [[Class: I2CE_Page | I2CE_Page]]. | ||
*Location: Part of the module [[I2CE Module List#admin|admin]] in the package [https://launchpad.net/i2ce I2CE] | *Location: Part of the module [[I2CE Module List#admin|admin]] in the package [https://launchpad.net/i2ce I2CE] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L29 modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 29 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
Default Admin Page | Default Admin Page | ||
| Line 8: | Line 8: | ||
===$shortname=== | ===$shortname=== | ||
the shortname of a module's config page we should be displaying | the shortname of a module's config page we should be displaying | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L35 i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 35 | |||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $shortname | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $shortname | ||
===$args=== | ===$args=== | ||
of strings -- any arguments for this page( from the URL) | of strings -- any arguments for this page( from the URL) | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L39 i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 39 | |||
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $args | *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $args | ||
| Line 17: | Line 19: | ||
===__construct()=== | ===__construct()=== | ||
Constructor -- called from page wrangler for URL of form admin/(module_name)/action/arg1/arg2 @param string $shortname A module name to show the admin page for. Defaults to null to mean no module. @param string $action The action this pages is to perform @param string $message. A message to display on the page. Defaults to null | Constructor -- called from page wrangler for URL of form admin/(module_name)/action/arg1/arg2 @param string $shortname A module name to show the admin page for. Defaults to null to mean no module. @param string $action The action this pages is to perform @param string $message. A message to display on the page. Defaults to null | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L49 i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 49 | |||
*Signature: public function __construct($args,$request_remainder) | *Signature: public function __construct($args,$request_remainder) | ||
*Parameters: | *Parameters: | ||
| Line 22: | Line 25: | ||
**$request_remainder | **$request_remainder | ||
===action()=== | ===action()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L63 i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 63 | |||
*Signature: protected function action() | *Signature: protected function action() | ||
===actionEnableDisable()=== | ===actionEnableDisable()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L81 i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 81 | |||
*Signature: protected function actionEnableDisable() | *Signature: protected function actionEnableDisable() | ||
===actionMenu()=== | ===actionMenu()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php#L133 i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php] on line 133 | |||
*Signature: protected function actionMenu() | *Signature: protected function actionMenu() | ||
==Inherited Methods== | ==Inherited Methods== | ||
Revision as of 08:51, 10 November 2009
This article describes the class I2CE_PageAdmin.
- Extends the class: I2CE_Page.
- Location: Part of the module admin in the package I2CE
- Source: Defined in the file modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
Default Admin Page
Variables
$shortname
the shortname of a module's config page we should be displaying
- Defined in i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 35
- Type: protected string $shortname
$args
of strings -- any arguments for this page( from the URL)
- Defined in i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 39
- Type: protected array $args
Methods
__construct()
Constructor -- called from page wrangler for URL of form admin/(module_name)/action/arg1/arg2 @param string $shortname A module name to show the admin page for. Defaults to null to mean no module. @param string $action The action this pages is to perform @param string $message. A message to display on the page. Defaults to null
- Defined in i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 49
- Signature: public function __construct($args,$request_remainder)
- Parameters:
- array $args
an array of strings - $request_remainder
- array $args
action()
- Defined in i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 63
- Signature: protected function action()
actionEnableDisable()
- Defined in i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 81
- Signature: protected function actionEnableDisable()
actionMenu()
- Defined in i2ce/modules/Pages/modules/Admin/lib/I2CE_PageAdmin.php on line 133
- Signature: protected function actionMenu()
Inherited Methods
_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()
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()
getAccess()
This protected method is inherited from I2CE_Page->getAccess()
getTitle()
This protected method is inherited from I2CE_Page->getTitle()
initializeTemplate()
This protected method is inherited from I2CE_Page->initializeTemplate()
loadHTMLTemplates()
This protected method is inherited from I2CE_Page->loadHTMLTemplates()
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
$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
$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()
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()
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()
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()
setShowForm()
This method is inherited from I2CE_Page->setShowForm()
showForm()
This method is inherited from I2CE_Page->showForm()
makeJumper()
This method is inherited from I2CE_Page->makeJumper()
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()
