| Fully Qualified Name: | Zend\Authentication\Adapter\Ldap |
| Extends: | AbstractAdapter |
| Name | Description | Defined By |
|---|---|---|
| __construct() | Constructor | Ldap |
| authenticate() | Authenticate the user | Ldap |
| getAccountObject() | getAccountObject() - Returns the result entry as a stdClass object | Ldap |
| getCredential() | Returns the credential of the account being authenticated, or NULL if none is set. | AbstractAdapter |
| getIdentity() | Returns the identity of the account being authenticated, or NULL if none is set. | AbstractAdapter |
| getLdap() | Returns the LDAP Object | Ldap |
| getOptions() | Returns the array of arrays of Zend\Ldap\Ldap options of this adapter. | Ldap |
| getPassword() | Returns the password of the account being authenticated, or NULL if none is set. | Ldap |
| getUsername() | Returns the username of the account being authenticated, or NULL if none is set. | Ldap |
| setCredential() | Sets the credential for binding | AbstractAdapter |
| setIdentity() | Sets the identity for binding | AbstractAdapter |
| setLdap() | Set an Ldap connection | Ldap |
| setOptions() | Sets the array of arrays of Zend\Ldap\Ldap options to be used by this adapter. | Ldap |
| setPassword() | Sets the password for the account | Ldap |
| setUsername() | Sets the username for binding | Ldap |
Constructor
| Parameter Name | Type | Description |
|---|---|---|
| $options | array | An |
| $identity | string | The |
| $credential | string | The |
Returns:
Authenticate the user
Returns: \AuthenticationResult
getAccountObject() - Returns the result entry as a stdClass object
This resembles the feature {@see \Zend\Authentication\Adapter\DbTable::getResultRowObject()}. Closes ZF-6813
| Parameter Name | Type | Description |
|---|---|---|
| $returnAttribs | array | |
| $omitAttribs | array |
Returns: \stdClass|bool
Returns the credential of the account being authenticated, or NULL if none is set.
Returns: mixed
Returns the identity of the account being authenticated, or NULL if none is set.
Returns: mixed
Returns the LDAP Object
Returns: \ZendLdap\Ldap The Zend\Ldap\Ldap object used to authenticate the credentials
Returns the array of arrays of Zend\Ldap\Ldap options of this adapter.
Returns: array|null
Returns the password of the account being authenticated, or NULL if none is set.
Returns: string|null
Returns the username of the account being authenticated, or NULL if none is set.
Returns: string|null
Sets the credential for binding
| Parameter Name | Type | Description |
|---|---|---|
| $credential | mixed |
Returns: self Provides a fluent interface
Sets the identity for binding
| Parameter Name | Type | Description |
|---|---|---|
| $identity | mixed |
Returns: self Provides a fluent interface
Set an Ldap connection
| Parameter Name | Type | Description |
|---|---|---|
| $ldap | \ZendLdap\Ldap | An |
Returns: self Provides a fluent interface
Sets the array of arrays of Zend\Ldap\Ldap options to be used by this adapter.
| Parameter Name | Type | Description |
|---|---|---|
| $options | array | The |
Returns: self Provides a fluent interface
Sets the password for the account
| Parameter Name | Type | Description |
|---|---|---|
| $password | string | The |
Returns: self Provides a fluent interface
Sets the username for binding
| Parameter Name | Type | Description |
|---|---|---|
| $username | string | The |
Returns: self Provides a fluent interface