Skip to content

icms_auth_method_ldap_Provisioning

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_auth_method_ldap_Provisioning

Authentication provisioning class. This class is responsible to provide synchronisation method to the user Database

  • Class name: icms_auth_method_ldap_Provisioning
  • Namespace:

Properties

$_auth_instance

private mixed $_auth_instance
  • Visibility: private

Methods

getInstance

\icms_auth_method_ldap_Provisioning icms_auth_method_ldap_Provisioning::getInstance(object auth_instance)

Gets instance

  • Visibility: public
  • This method is static.

Arguments

  • auth_instance object

__construct

mixed icms_auth_method_ldap_Provisioning::__construct(\icms_auth_method_ldap_Provisioning auth_instance)

Authentication Service constructor

  • Visibility: public

Arguments

geticms_member_user_Object

\icms_member_user_Object|bool icms_auth_method_ldap_Provisioning::geticms_member_user_Object(string uname)

Return a User Object

  • Visibility: public

Arguments

  • uname string - <p>Username of the user</p>

sync

\icms_member_user_Object icms_auth_method_ldap_Provisioning::sync(array datas, string uname, string pwd)

Launch the synchronisation process

  • Visibility: public

Arguments

  • datas array - <p>Some Data</p>
  • uname string - <p>Username of the user</p>
  • pwd string - <p>Password of the user</p>

add

array icms_auth_method_ldap_Provisioning::add(array datas, string uname, string pwd)

Adds a new user to the system

  • Visibility: public

Arguments

  • datas array - <p>Some Data</p>
  • uname string - <p>Username of the user</p>
  • pwd string - <p>Password of the user</p>

change

\icms_member_user_Object icms_auth_method_ldap_Provisioning::change(\icms_member_user_Object icmsUser, array datas, string uname, string pwd)

Modify user information

  • Visibility: public

Arguments

  • icmsUser icms_member_user_Object - <p>reference</p>
  • datas array - <p>Some Data</p>
  • uname string - <p>Username of the user</p>
  • pwd string - <p>Password of the user</p>
Clone this wiki locally