Class: iHRIS Module ManageAccessFacility (Development)

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

This article describes the class iHRIS_Module_ManageAccessFacility .

• Extends the class: I2CE_ModuleAccess.
• Location: Part of the module ManageAccessFacility in the package iHRIS Manage 4.1-dev
• Source: Defined in the file modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 33
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v4.1.0

@filesource Class iHRIS_Module_ManageAccessFacility

Variables

$user_access_facility

A cached list of facility_access for a username

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 38
• Type: static protected array $user_access_facility

$report_limit_options

A list of limit options for this module.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 43
• Type: static protected array $report_limit_options

Methods

ValidateAccessAgainstWalkableForms()

Check to see if we have access based on a list of access ids and form objects which we are allowed to edit @param array $fieldsWalks, arrays whos keys are the forms we are looking for, and value is either a mapped field of that form we want to walk or false.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 482
• Signature: public function ValidateAccessAgainstWalkableForms($fieldWalks,$access,$formObjs)
• Parameters:
  • $fieldWalks
  • array $access
    with keys form name, and values and array containing formids form that form which we are checking for access agagins
  • array $formObjs
    with keys the name of a form and value a instance I2CE_Form for that form

action_access_facility()

Handle the display for the access_facility form on the view user page.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 159
• Signature: public function action_access_facility($page)
• Parameters:
  • $page
• Returns: boolean

getAccessLocation()

Return a list of locations the user is allowed to access.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 188
• Signature: static public function getAccessLocation($user)
• Parameters:
  • I2CE_User $user
• Returns: array
  with keys form name, and values and array containing formids form that form

getHooks()

Retrn the array of hooks available in this module.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 59
• Signature: static public function getHooks()
• Returns: array

getLimitAdd()

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

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 113
• Signature: public function getLimitAdd($formObj,$args)
• Parameters:
  • I2CE_Form $formObj
  • array $args
• Returns: array

getLimitsByForm()

Return the list of allowed id values for the given form assigned to the current user. If the form isn't given directly by this user then return an empty array. Return true if there is no limits at all for this user.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 143
• Signature: public function getLimitsByForm($form)
• Parameters:
  • string $form
• Returns: mixed

getMethods()

Return the list of fuzzy methods handled by this module.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 49
• Signature: static public function getMethods()
• Returns: array

getTemplateForms()

Helper method to get forms objects in template

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 410
• Signature: public function getTemplateForms($template,$node,$forms)
• Parameters:
  • I2CE_Template $template
  • DOMNode $node
  • array $forms
    of string, the name of the forms

get_report_limit_options()

Return the array of details for report limit options for this module.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 70
• Signature: public function get_report_limit_options()
• Returns: array

removeFormName()

Static helper method to remove the given form name from an id.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 102
• Signature: static protected function removeFormName($item,$key,$form)
• Parameters:
  • string &$item
    An entry in an array.
  • mixed $key
    The array key for this item.
  • string $form
    The form name to remove.

userAccessFacility()

Template function to see if person_can_view_child_forms @param string $link

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 222
• Signature: public function userAccessFacility($node,$template)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template

userAccessFacilityDataEntrant()

Template function to see if person_can_view_child_forms @param string $link

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 347
• Signature: public function userAccessFacilityDataEntrant($node,$template)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template

userAccessFacilityList()

Template function to see if can_edit_database_list_position for the

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 433
• Signature: public function userAccessFacilityList($node,$template)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template
• Returns: boolean

userAccessFacilityStaff()

Template function to see if person_can_view_child_forms @param string $link

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 285
• Signature: public function userAccessFacilityStaff($node,$template)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template

userAccessWalkableForms()

Template function to see if can_edit_database_list_position for the @param array $fieldsWalks, arrays whos keys are the forms we are looking for, and value is either a mapped field of that form we want to walk or false.

• Defined in manage/modules/ManageAccessFacility/lib/iHRIS_Module_ManageAccessFacility.php on line 457
• Signature: public function userAccessWalkableForms($node,$template,$fieldWalks,$permit_empty)
• Parameters:
  • DOMNode $node
  • I2CE_Template $template
  • $fieldWalks
  • boolean $permit_empty
    Defaults to true in which case we grant permission if none of the forms from {$fieldWalks} are found in the template, or if there is no template
    • Default Value: true
• Returns: boolean;

Inherited Methods

__construct()

This public method is inherited from I2CE_ModuleAccess->__construct()

getUser()

This public method is inherited from I2CE_ModuleAccess->getUser()

setUser()

This public method is inherited from I2CE_ModuleAccess->setUser()

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

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 Variables

$user

Theis protected variable is inherited from I2CE_ModuleAccess->$user

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