Class: iHRIS Module (Development): Difference between revisions
(Created page with '{{otherversions|Class: iHRIS_Module}} This article describes the class ''iHRIS_Module'' . *Extends the class: I2CE_Module. *Location: Part …') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''iHRIS_Module'' . | This article describes the class ''iHRIS_Module'' . | ||
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | ||
*Location: Part of the module [[iHRIS Common Module List (Development)#ihris-common|ihris-common]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4. | *Location: Part of the module [[iHRIS Common Module List (Development)#ihris-common|ihris-common]] 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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L3 lib/iHRIS_Module.php] on line 3 | ||
==Methods== | ==Methods== | ||
===getHooks()=== | |||
Return the list of hooks provided by this module. | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L10 common/lib/iHRIS_Module.php] on line 10 | |||
*Signature: static public function getHooks() | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | |||
===getModuleVersion()=== | ===getModuleVersion()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L106 common/lib/iHRIS_Module.php] on line 106 | ||
*Signature: public function getModuleVersion($module) | *Signature: public function getModuleVersion($module) | ||
*Parameters: | *Parameters: | ||
**$module | **$module | ||
===getUserNames()=== | ===getUserNames()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L58 common/lib/iHRIS_Module.php] on line 58 | ||
*Signature: public function getUserNames() | *Signature: public function getUserNames() | ||
===getUserRole()=== | ===getUserRole()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L87 common/lib/iHRIS_Module.php] on line 87 | ||
*Signature: public function getUserRole() | *Signature: public function getUserRole() | ||
===set_active_menu_auto_list()=== | |||
Set the active menu for the auto_list page. @param $page I2CE_PageFormLists | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L30 common/lib/iHRIS_Module.php] on line 30 | |||
*Signature: public function set_active_menu_auto_list($page) | |||
*Parameters: | |||
**$page | |||
===set_active_menu_href()=== | |||
Set the active menu for either lists page by the href to set active @param $page I2CE_PageFormLists @param $href string | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L39 common/lib/iHRIS_Module.php] on line 39 | |||
*Signature: public function set_active_menu_href($page,$href) | |||
*Parameters: | |||
**$page | |||
**$href | |||
===set_active_menu_lists()=== | |||
Set the active menu for the lists page. @param $page I2CE_PageFormLists | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L22 common/lib/iHRIS_Module.php] on line 22 | |||
*Signature: public function set_active_menu_lists($page) | |||
*Parameters: | |||
**$page | |||
===showModuleVersion()=== | ===showModuleVersion()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L99 common/lib/iHRIS_Module.php] on line 99 | ||
*Signature: public function showModuleVersion($node,$template,$module) | *Signature: public function showModuleVersion($node,$template,$module) | ||
*Parameters: | *Parameters: | ||
Line 24: | Line 48: | ||
**$module | **$module | ||
===showUserNames()=== | ===showUserNames()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L47 common/lib/iHRIS_Module.php] on line 47 | ||
*Signature: public function showUserNames($node,$template) | *Signature: public function showUserNames($node,$template) | ||
*Parameters: | *Parameters: | ||
Line 30: | Line 54: | ||
**$template | **$template | ||
===showUserRole()=== | ===showUserRole()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L81 common/lib/iHRIS_Module.php] on line 81 | ||
*Signature: public function showUserRole($node,$template) | *Signature: public function showUserRole($node,$template) | ||
*Parameters: | *Parameters: | ||
**$node | **$node | ||
**$template | **$template | ||
===welcomeNamedUser()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/lib/iHRIS_Module.php#L65 common/lib/iHRIS_Module.php] on line 65 | |||
*Signature: public function welcomeNamedUser($node,$template,$named_welcome_str,$unamed_welcome_str) | |||
*Parameters: | |||
**$node | |||
**$template | |||
**$named_welcome_str | |||
**$unamed_welcome_str | |||
***Default Value: '' | |||
==Inherited Methods== | ==Inherited Methods== | ||
===__construct()=== | ===__construct()=== | ||
Line 50: | Line 83: | ||
===action_initialize()=== | ===action_initialize()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]] | This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]] | ||
===getCLIMethods()=== | ===getCLIMethods()=== | ||
Line 59: | Line 89: | ||
===getConfig()=== | ===getConfig()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]] | This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]] | ||
===getMethods()=== | ===getMethods()=== |
Latest revision as of 08:26, 6 May 2015
This article describes the class iHRIS_Module .
- Extends the class: I2CE_Module.
- Location: Part of the module ihris-common in the package iHRIS Common 4.1-dev
- Source: Defined in the file lib/iHRIS_Module.php on line 3
Methods
getHooks()
Return the list of hooks provided by this module.
- Defined in common/lib/iHRIS_Module.php on line 10
- Signature: static public function getHooks()
- Returns: array
getModuleVersion()
- Defined in common/lib/iHRIS_Module.php on line 106
- Signature: public function getModuleVersion($module)
- Parameters:
- $module
getUserNames()
- Defined in common/lib/iHRIS_Module.php on line 58
- Signature: public function getUserNames()
getUserRole()
- Defined in common/lib/iHRIS_Module.php on line 87
- Signature: public function getUserRole()
Set the active menu for the auto_list page. @param $page I2CE_PageFormLists
- Defined in common/lib/iHRIS_Module.php on line 30
- Signature: public function set_active_menu_auto_list($page)
- Parameters:
- $page
Set the active menu for either lists page by the href to set active @param $page I2CE_PageFormLists @param $href string
- Defined in common/lib/iHRIS_Module.php on line 39
- Signature: public function set_active_menu_href($page,$href)
- Parameters:
- $page
- $href
Set the active menu for the lists page. @param $page I2CE_PageFormLists
- Defined in common/lib/iHRIS_Module.php on line 22
- Signature: public function set_active_menu_lists($page)
- Parameters:
- $page
showModuleVersion()
- Defined in common/lib/iHRIS_Module.php on line 99
- Signature: public function showModuleVersion($node,$template,$module)
- Parameters:
- $node
- $template
- $module
showUserNames()
- Defined in common/lib/iHRIS_Module.php on line 47
- Signature: public function showUserNames($node,$template)
- Parameters:
- $node
- $template
showUserRole()
- Defined in common/lib/iHRIS_Module.php on line 81
- Signature: public function showUserRole($node,$template)
- Parameters:
- $node
- $template
welcomeNamedUser()
- Defined in common/lib/iHRIS_Module.php on line 65
- Signature: public function welcomeNamedUser($node,$template,$named_welcome_str,$unamed_welcome_str)
- Parameters:
- $node
- $template
- $named_welcome_str
- $unamed_welcome_str
- Default Value:
Inherited Methods
__construct()
This public method is inherited from I2CE_Module->__construct()
action_configure()
This public method is inherited from I2CE_Module->action_configure()
action_disable()
This public method is inherited from I2CE_Module->action_disable()
action_enable()
This public method is inherited from I2CE_Module->action_enable()
action_initialize()
This public method is inherited from I2CE_Module->action_initialize()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
getMethods()
This public method is inherited from I2CE_Module->getMethods()
post_update()
This public method is inherited from I2CE_Module->post_update()
pre_upgrade()
This public method is inherited from I2CE_Module->pre_upgrade()
upgrade()
This public method is inherited from I2CE_Module->upgrade()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Fuzzy Methods
launchBackgroundProcess()
This method is inherited from I2CE_Module->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is inherited from I2CE_Module->launchBackgroundPHPScript()
launchBackgroundPage()
This method is inherited from I2CE_Module->launchBackgroundPage()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()