Class LDAPProxy
Manages LDAP connections through built-in PHP LDAP support
The configuration file for the LDAPProxy class is config/ldap_config.inc.
A sample configuration file is config/samples/ldap_config.inc.sample.
A user with read-access to the LDAP server must be set up in the
configuration file for queries to be possible.
-
hrm\user\proxy\AbstractProxy
-
hrm\user\proxy\LDAPProxy
Namespace: hrm\
user\
proxy
Package: hrm
Located at user/proxy/LDAPProxy.php
Methods summary
public
|
#
__construct( )
LDAPProxy constructor: : instantiates an LDAPProxy object
with the settings specified in the configuration file.
LDAPProxy constructor: : instantiates an LDAPProxy object
with the settings specified in the configuration file.
|
public
|
#
__destruct( )
Destructor: closes the connection.
Destructor: closes the connection.
|
public
string
|
#
friendlyName( )
Return a friendly name for the proxy to be displayed in the ui.
Return a friendly name for the proxy to be displayed in the ui.
Returns
string
'generic ldap'.
|
public
string|null
|
#
getEmailAddress( string $uid )
Returna the email address of user with given username.
Returna the email address of user with given username.
Parameters
- $uid
- Username for which to query the email address.
Returns
string|null
email address or null.
|
public
boolean
|
#
authenticate( string $uid, string $userPassword )
Authenticates the User with given username and password against LDAP.
Authenticates the User with given username and password against LDAP.
Parameters
- $uid
- Username for authentication.
- $userPassword
- Plain password for authentication.
Returns
boolean
True if authentication succeeded, false otherwise.
|
public
string
|
#
getGroup( string $uid )
Returns the group the user with given username belongs to.
Returns the group the user with given username belongs to.
Parameters
- $uid
- Username for which to query the group.
Returns
string
Group or "" if not found.
|
public
boolean
|
#
isConnected( )
Checks whether there is a connection to LDAP.
Checks whether there is a connection to LDAP.
Returns
boolean
True if the connection is up, false otherwise.
|
public
string
|
#
lastError( )
Returns the last occurred error.
Returns the last occurred error.
Returns
string
Last LDAP error.
|