Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

string
$_authenticatedDn= 'null'
The DN of the authenticated account. Used to retrieve the account entry on request.
null
Details
array
$_options= 'null'
The array of arrays of Zend_Ldap options passed to the constructor.
null
Details
string
$_password= 'null'
The password of the account being authenticated.
null
Details
__construct(
array $options
=
array(), string $username
=
null, string $password
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$options | array | An array of arrays of Zend_Ldap options |
$username | string | The username of the account being authenticated |
$password | string | The password of the account being authenticated |

_checkGroupMembership(
\Zend_Ldap $ldap, string $canonicalName, string $dn, array $adapterOptions
)
:
string|true
Checks the group membership of the bound user
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap | |
$canonicalName | string | |
$dn | string | |
$adapterOptions | array |
Type | Description |
---|---|
string|true |

_getAuthorityName(
)
:
string
Returns a domain name for the current LDAP options. This is used for skipping redundant operations (e.g. authentications).
Type | Description |
---|---|
string |

_optionsToString(
array $options
)
:
string
Converts options to string
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
string |

_prepareOptions(
\Zend_Ldap $ldap, array $options
)
:
array
Sets the LDAP specific options on the Zend_Ldap instance
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap | |
$options | array |
Type | Description |
---|---|
array | of auth-adapter specific options |

authenticate(
)
:
\Zend_Auth_Result
Authenticate the user
Type | Description |
---|---|
\Zend_Auth_Result |
Exception | Description |
---|---|
\Zend_Auth_Adapter_Exception |

getAccountObject(
array $returnAttribs
=
array(), array $omitAttribs
=
array()
)
:
\stdClass|boolean
getAccountObject() - Returns the result entry as a stdClass object
This resembles the feature {@see Zend_Auth_Adapter_DbTable::getResultRowObject()}. Closes ZF-6813
Name | Type | Description |
---|---|---|
$returnAttribs | array | |
$omitAttribs | array |
Type | Description |
---|---|
\stdClass|boolean |

getLdap(
)
:
\Zend_Ldap
Returns the LDAP Object
Type | Description |
---|---|
\Zend_Ldap | The Zend_Ldap object used to authenticate the credentials |

getOptions(
)
:
array|null
Returns the array of arrays of Zend_Ldap options of this adapter.
Type | Description |
---|---|
array|null |

getPassword(
)
:
string|null
Returns the password of the account being authenticated, or NULL if none is set.
Type | Description |
---|---|
string|null |

getUsername(
)
:
string|null
Returns the username of the account being authenticated, or NULL if none is set.
Type | Description |
---|---|
string|null |

setCredential(
string $credential
)
:
\Zend_Auth_Adapter_Ldap
setCredential() - set the credential (password) value to be used
Proxies to {@see setPassword()}
Closes ZF-6813
Name | Type | Description |
---|---|---|
$credential | string |
Type | Description |
---|---|
\Zend_Auth_Adapter_Ldap | Provides a fluent interface |

setIdentity(
string $identity
)
:
\Zend_Auth_Adapter_Ldap
setIdentity() - set the identity (username) to be used
Proxies to {@see setUsername()}
Closes ZF-6813
Name | Type | Description |
---|---|---|
$identity | string |
Type | Description |
---|---|
\Zend_Auth_Adapter_Ldap | Provides a fluent interface |

setLdap(
\Zend_Ldap $ldap
)
:
\Zend_Auth_Adapter_Ldap
Set an Ldap connection
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap | An existing Ldap object |
Type | Description |
---|---|
\Zend_Auth_Adapter_Ldap | Provides a fluent interface |

setOptions(
array $options
)
:
\Zend_Auth_Adapter_Ldap
Sets the array of arrays of Zend_Ldap options to be used by this adapter.
Name | Type | Description |
---|---|---|
$options | array | The array of arrays of Zend_Ldap options |
Type | Description |
---|---|
\Zend_Auth_Adapter_Ldap | Provides a fluent interface |

setPassword(
string $password
)
:
\Zend_Auth_Adapter_Ldap
Sets the passwort for the account
Name | Type | Description |
---|---|---|
$password | string | The password of the account being authenticated |
Type | Description |
---|---|
\Zend_Auth_Adapter_Ldap | Provides a fluent interface |

setUsername(
string $username
)
:
\Zend_Auth_Adapter_Ldap
Sets the username for binding
Name | Type | Description |
---|---|---|
$username | string | The username for binding |
Type | Description |
---|---|
\Zend_Auth_Adapter_Ldap | Provides a fluent interface |