Auth/Adapter/Ldap.php

Show:

inherited

Classes
- \Zend_Auth_Adapter_Ldap

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Auth
Subpackage: Zend_Auth_Adapter
Version: $Id: Ldap.php 24618 2012-02-03 08:32:06Z sgehrig $

\Zend_Auth_Adapter_Ldap
jump to top

Package: Zend\Auth\Zend\Auth\Adapter

Implements: \Zend_Auth_Adapter_Interface
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_authenticatedDn = null

The DN of the authenticated account.

Used to retrieve the account entry on request.

Default valuenullDetails

Type: string

\Zend_Ldap $_ldap = null

The Zend_Ldap context.

Default valuenullDetails

Type: \Zend_Ldap

array $_options = null

The array of arrays of Zend_Ldap options passed to the constructor.

Default valuenullDetails

Type: array

string $_password = null

The password of the account being authenticated.

Default valuenullDetails

Type: string

string $_username = null

The username of the account being authenticated.

Default valuenullDetails

Type: string

Methods

__construct(array $options = array(), string $username = null, string $password = null) : void

Constructor

Parameters

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

Parameters

Name	Type	Description
$ldap	\Zend_Ldap
$canonicalName	string
$dn	string
$adapterOptions	array

Returns

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).

Returns

Type	Description
string

_optionsToString(array $options) : string

Converts options to string

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
string

_prepareOptions(\Zend_Ldap $ldap, array $options) : array

Sets the LDAP specific options on the Zend_Ldap instance

Parameters

Name	Type	Description
$ldap	\Zend_Ldap
$options	array

Returns

Type	Description
array	of auth-adapter specific options

authenticate() : \Zend_Auth_Result

Authenticate the user

Returns

Type	Description
\Zend_Auth_Result

Throws

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

Parameters

Name	Type	Description
$returnAttribs	array
$omitAttribs	array

Returns

Type	Description
\stdClass \| boolean

getLdap() : \Zend_Ldap

Returns the LDAP Object

Returns

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.

Returns

Type	Description
array \| null

getPassword() : string | null

Returns the password of the account being authenticated, or NULL if none is set.

Returns

Type	Description
string \| null

getUsername() : string | null

Returns the username of the account being authenticated, or NULL if none is set.

Returns

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

Parameters

Name	Type	Description
$credential	string

Returns

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

Parameters

Name	Type	Description
$identity	string

Returns

Type	Description
\Zend_Auth_Adapter_Ldap	Provides a fluent interface

setLdap(\Zend_Ldap $ldap) : \Zend_Auth_Adapter_Ldap

Set an Ldap connection

Parameters

Name	Type	Description
$ldap	\Zend_Ldap	An existing Ldap object

Returns

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.

Parameters

Name	Type	Description
$options	array	The array of arrays of Zend_Ldap options

Returns

Type	Description
\Zend_Auth_Adapter_Ldap	Provides a fluent interface

setPassword(string $password) : \Zend_Auth_Adapter_Ldap

Sets the passwort for the account

Parameters

Name	Type	Description
$password	string	The password of the account being authenticated

Returns

Type	Description
\Zend_Auth_Adapter_Ldap	Provides a fluent interface

setUsername(string $username) : \Zend_Auth_Adapter_Ldap

Sets the username for binding

Parameters

Name	Type	Description
$username	string	The username for binding

Returns

Type	Description
\Zend_Auth_Adapter_Ldap	Provides a fluent interface