Class: I2CE ModuleAccess (Development)

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

This article describes the abstract class I2CE_ModuleAccess .

• Extends the class: I2CE_Module.
• Child Classes:
  • iHRIS_Module_ManageAccessFacility
• Location: Part of the module forms in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/lib/I2CE_ModuleAccess.php on line 29
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: 4.1.1

The abstract class for that all access modules must implement

Variables

$user

The current user object.

• Defined in i2ce/modules/Forms/lib/I2CE_ModuleAccess.php on line 34
• Type: protected I2CE_User $user

Methods

__construct()

Create this module object to set the current user.

• Defined in i2ce/modules/Forms/lib/I2CE_ModuleAccess.php on line 59
• Signature: public function __construct()

getLimitAdd()

Return an array of limit_add options to add for this user to limit fields.

• Defined in i2ce/modules/Forms/lib/I2CE_ModuleAccess.php on line 43
• Signature: abstract public function getLimitAdd($formObj,$args)
• Parameters:
  • I2CE_Form $formObj
  • array $args
• Returns: array

getLimitsByForm()

Return the list of allowed fields for the given form for this access module. Return true if there are no limits at all set for the user. (i.e. everything is allowed)

• Defined in i2ce/modules/Forms/lib/I2CE_ModuleAccess.php on line 53
• Signature: abstract public function getLimitsByForm($form)
• Parameters:
  • string $form
• Returns: mixed

getUser()

Return the current user object.

• Defined in i2ce/modules/Forms/lib/I2CE_ModuleAccess.php on line 81
• Signature: public function getUser()
• Returns: I2CE_User

setUser()

Set the user for this module. This is for any command line access that needs to override the user.

• Defined in i2ce/modules/Forms/lib/I2CE_ModuleAccess.php on line 69
• Signature: public function setUser($user)
• Parameters:
  • I2CE_User $user

Inherited Methods

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

getHooks()

This public method is inherited from I2CE_Module->getHooks()

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