Auth/Adapter/Ldap.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Auth
subpackage: Zend_Auth_Adapter
version: $Id: Ldap.php 21320 2010-03-04 16:05:09Z sgehrig $
Classes: Zend_Auth_Adapter_Ldap

Description

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.

Zend_Auth_Adapter_Ldap
jump to top

Implements: Zend_Auth_Adapter_Interface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Auth
subpackage: Zend_Auth_Adapter
Properties: $_ldap; $_options; $_username; $_password; $_authenticatedDn
Methods: __construct; getOptions; setOptions; getUsername; setUsername; getPassword; setPassword; setIdentity; setCredential; getLdap; setLdap; _getAuthorityName; authenticate; _prepareOptions; _checkGroupMembership; getAccountObject; _optionsToString

Description

Properties

$_authenticatedDn
jump to class

string $_authenticatedDn = 'null'

The DN of the authenticated account. Used to retrieve the account entry on request.

Details

$_authenticatedDn: string
visibility: protected
default: null
final: false
static: false

$_ldap
jump to class

Zend_Ldap $_ldap = 'null'

The Zend_Ldap context.

Details

$_ldap: Zend_Ldap
visibility: protected
default: null
final: false
static: false

$_options
jump to class

array $_options = 'null'

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

Details

$_options: array
visibility: protected
default: null
final: false
static: false

$_password
jump to class

string $_password = 'null'

The password of the account being authenticated.

Details

$_password: string
visibility: protected
default: null
final: false
static: false

$_username
jump to class

string $_username = 'null'

The username of the account being authenticated.

Details

$_username: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$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

Details

visibility: public
final: false
static: false

_checkGroupMembership
jump to class

_checkGroupMembership(
          Zend_Ldap $ldap, string $canonicalName, string $dn, array $adapterOptions
          )
        
        :
        string|true

Checks the group membership of the bound user

Arguments

$ldap: Zend_Ldap
$canonicalName: string
$dn: string
$adapterOptions: array

Output

string|true

Details

visibility: protected
final: false
static: false

_getAuthorityName
jump to class

_getAuthorityName(
          
          )
        
        :
        string

Returns a domain name for the current LDAP options. This is used for skipping redundant operations (e.g. authentications).

Output

string

Details

visibility: protected
final: false
static: false

_optionsToString
jump to class

_optionsToString(
          array $options
          )
        
        :
        string

Converts options to string

Arguments

$options: array

Output

string

Details

visibility: private
final: false
static: false

_prepareOptions
jump to class

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

Sets the LDAP specific options on the Zend_Ldap instance

Arguments

$ldap: Zend_Ldap
$options: array

Output

array: of auth-adapter specific options

Details

visibility: protected
final: false
static: false

authenticate
jump to class

authenticate(
          
          )
        
        :
        Zend_Auth_Result

Authenticate the user

Output

Zend_Auth_Result

Details

visibility: public
final: false
static: false
throws

getAccountObject
jump to class

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

Arguments

$returnAttribs: array
$omitAttribs: array

Output

stdClass|boolean

Details

visibility: public
final: false
static: false

getLdap
jump to class

getLdap(
          
          )
        
        :
        Zend_Ldap

Returns the LDAP Object

Output

Zend_Ldap: The Zend_Ldap object used to authenticate the credentials

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array|null

Returns the array of arrays of Zend_Ldap options of this adapter.

Output

array|null

Details

visibility: public
final: false
static: false

getPassword
jump to class

getPassword(
          
          )
        
        :
        string|null

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

Output

string|null

Details

visibility: public
final: false
static: false

getUsername
jump to class

getUsername(
          
          )
        
        :
        string|null

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

Output

string|null

Details

visibility: public
final: false
static: false

setCredential
jump to class

setCredential(
          string $credential
          )
        
        :
        Zend_Auth_Adapter_Ldap

setCredential() - set the credential (password) value to be used

Proxies to {@see setPassword()}

Closes ZF-6813

Arguments

$credential: string

Output

Zend_Auth_Adapter_Ldap: Provides a fluent interface

Details

visibility: public
final: false
static: false

setIdentity
jump to class

setIdentity(
          string $identity
          )
        
        :
        Zend_Auth_Adapter_Ldap

setIdentity() - set the identity (username) to be used

Proxies to {@see setUsername()}

Closes ZF-6813

Arguments

$identity: string

Output

Zend_Auth_Adapter_Ldap: Provides a fluent interface

Details

visibility: public
final: false
static: false

setLdap
jump to class

setLdap(
          Zend_Ldap $ldap
          )
        
        :
        Zend_Auth_Adapter_Ldap

Set an Ldap connection

Arguments

$ldap: Zend_Ldap
An existing Ldap object

Output

Zend_Auth_Adapter_Ldap: Provides a fluent interface

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Auth_Adapter_Ldap

Sets the array of arrays of Zend_Ldap options to be used by this adapter.

Arguments

$options: array
The array of arrays of Zend_Ldap options

Output

Zend_Auth_Adapter_Ldap: Provides a fluent interface

Details

visibility: public
final: false
static: false

setPassword
jump to class

setPassword(
          string $password
          )
        
        :
        Zend_Auth_Adapter_Ldap

Sets the passwort for the account

Arguments

$password: string
The password of the account being authenticated

Output

Zend_Auth_Adapter_Ldap: Provides a fluent interface

Details

visibility: public
final: false
static: false

setUsername
jump to class

setUsername(
          string $username
          )
        
        :
        Zend_Auth_Adapter_Ldap

Sets the username for binding

Arguments

$username: string
The username for binding

Output

Zend_Auth_Adapter_Ldap: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Auth/Adapter/Ldap.php

Description

Zend_Auth_Adapter_Ldapjump to top

Description

Properties

$_authenticatedDnjump to class

Details

$_ldapjump to class

Details

$_optionsjump to class

Details

$_passwordjump to class

Details

$_usernamejump to class

Details

Methods

__constructjump to class

Arguments

Details

_checkGroupMembershipjump to class

Arguments

Output

Details

_getAuthorityNamejump to class

Output

Details

_optionsToStringjump to class

Arguments

Output

Details

_prepareOptionsjump to class

Arguments

Output

Details

authenticatejump to class

Output

Details

getAccountObjectjump to class

Arguments

Output

Details

getLdapjump to class

Output

Details

getOptionsjump to class

Output

Details

getPasswordjump to class

Output

Details

getUsernamejump to class

Output

Details

setCredentialjump to class

Arguments

Output

Details

setIdentityjump to class

Arguments

Output

Details

setLdapjump to class

Arguments

Output

Details

setOptionsjump to class

Arguments

Output

Details

setPasswordjump to class

Arguments

Output

Details

setUsernamejump to class

Arguments

Output

Details

Zend_Auth_Adapter_Ldap
jump to top

$_authenticatedDn
jump to class

$_ldap
jump to class

$_options
jump to class

$_password
jump to class

$_username
jump to class

__construct
jump to class

_checkGroupMembership
jump to class

_getAuthorityName
jump to class

_optionsToString
jump to class

_prepareOptions
jump to class

authenticate
jump to class

getAccountObject
jump to class

getLdap
jump to class

getOptions
jump to class

getPassword
jump to class

getUsername
jump to class

setCredential
jump to class

setIdentity
jump to class

setLdap
jump to class

setOptions
jump to class

setPassword
jump to class

setUsername
jump to class