Zend\Authentication\Adapter\Ldap
Synopsis
class Ldap
extends AbstractAdapter
{
- // members
- protected Ldap $ldap;
- protected array $options;
- protected string $authenticatedDn;
- // Inherited members from AbstractAdapter
- protected mixed $credential;
- protected mixed $identity;
- // methods
- public void __construct()
- public array|null getOptions()
- public Ldap setOptions()
- public string|null getUsername()
- public Ldap setUsername()
- public string|null getPassword()
- public Ldap setPassword()
- public Ldap getLdap()
- public Ldap setLdap()
- protected string getAuthorityName()
- public Result authenticate()
- protected array prepareOptions()
- protected string|true checkGroupMembership()
- public stdClass|bool getAccountObject()
- private string optionsToString()
- // Inherited methods from AbstractAdapter
- public mixed getCredential()
- public AbstractAdapter setCredential()
- public mixed getIdentity()
- public AbstractAdapter setIdentity()
Hierarchy
Members
protected
- $authenticatedDn
—
string
The DN of the authenticated account. Used to retrieve the account entry on request. - $credential — mixed
- $identity — mixed
- $ldap
—
Zend\Authentication\Adapter\ZendLdap\Ldap
The Zend\Ldap\Ldap context. - $options
—
array
The array of arrays of Zend\Ldap\Ldap options passed to the constructor.
Methods
private
- optionsToString() — Converts options to string
protected
- checkGroupMembership() — Checks the group membership of the bound user
- getAuthorityName() — Returns a domain name for the current LDAP options. This is used for skipping redundant operations (e.g. authentications).
- prepareOptions() — Sets the LDAP specific options on the Zend\Ldap\Ldap instance
public
- __construct() — Constructor
- authenticate() — Authenticate the user
- getAccountObject() — getAccountObject() - Returns the result entry as a stdClass object
- getLdap() — Returns the LDAP Object
- getOptions() — Returns the array of arrays of Zend\Ldap\Ldap options of this adapter.
- getPassword() — Returns the password of the account being authenticated, or NULL if none is set.
- getUsername() — Returns the username of the account being authenticated, or NULL if none is set.
- setLdap() — Set an Ldap connection
- setOptions() — Sets the array of arrays of Zend\Ldap\Ldap options to be used by this adapter.
- setPassword() — Sets the password for the account
- setUsername() — Sets the username for binding
Inherited from Zend\Authentication\Adapter\AbstractAdapter
public
- getCredential() — Returns the credential of the account being authenticated, or NULL if none is set.
- getIdentity() — Returns the identity of the account being authenticated, or NULL if none is set.
- setCredential() — Sets the credential for binding
- setIdentity() — Sets the identity for binding