Class: I2CE Module UserAccess LDAP (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_Module_UserAccess_LDAP}} This article describes the class ''I2CE_Module_UserAccess_LDAP'' . *Extends the class: [[Class: I2CE_Module (Development) | I…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_Module_UserAccess_LDAP'' .
This article describes the class ''I2CE_Module_UserAccess_LDAP'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[I2CE Module List (Development)#UserAccess_LDAP|UserAccess_LDAP]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#UserAccess_LDAP|UserAccess_LDAP]] 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/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L33 modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 33
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L33 modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 33
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v4.0.3
*Since: v4.0.3
Line 10: Line 10:
===action_initialize()===
===action_initialize()===
Method called when the module is enabled for the first time.
Method called when the module is enabled for the first time.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L139 i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 139
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L139 i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 139
*Signature: public function action_initialize()
*Signature: public function action_initialize()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>returns true on success. false on error.
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>returns true on success. false on error.
===ensureDefaultOptions()===
===ensureDefaultOptions()===
ensrure default options are set
ensrure default options are set
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L41 i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 41
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L41 i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 41
*Signature: static public function ensureDefaultOptions($options)
*Signature: static public function ensureDefaultOptions($options)
*Parameters:
*Parameters:
Line 22: Line 22:
===ensureOrganizationalEntries()===
===ensureOrganizationalEntries()===
Ensure the organziational entries in the LDAP server for People and Application
Ensure the organziational entries in the LDAP server for People and Application
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L155 i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 155
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php#L155 i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_Module_UserAccess_LDAP.php] on line 155
*Signature: protected function ensureOrganizationalEntries()
*Signature: protected function ensureOrganizationalEntries()
*Returns: boolean.<br/>True on success
*Returns: boolean.<br/>True on success
Line 37: Line 37:
===action_enable()===
===action_enable()===
This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]]
This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module (Development)#getCLIHooks() | I2CE_Module->getCLIHooks()]]


===getCLIMethods()===
===getCLIMethods()===

Latest revision as of 09:16, 6 May 2015

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


This article describes the class I2CE_Module_UserAccess_LDAP .

@filesource Class I2CE_Module_UserAccess

Methods

action_initialize()

Method called when the module is enabled for the first time.

ensureDefaultOptions()

ensrure default options are set

ensureOrganizationalEntries()

Ensure the organziational entries in the LDAP server for People and Application

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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Module_UserAccess_LDAP_(Development)&oldid=53852"