Path

ez components / documentation / api reference / latest / authentication


eZ Components latest

Authentication: ezcAuthenticationLdapOptions

[ Tutorial ] [ Rfcs ] [ Security ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcAuthenticationLdapOptions

Class containing the options for ldap authentication filter. [source]
Example of use:
 1.  // create an options object
 2.  $options new ezcAuthenticationLdapOptions();
 3.  $options->protocol ezcAuthenticationLdapFilter::PROTOCOL_TLS;
 4.  
 5.  // use the options object when creating a new LDAP filter
 6.  $ldap new ezcAuthenticationLdapInfo'localhost''uid=%id%''dc=example,dc=com'389 );
 7.  $filter new ezcAuthenticationLdapFilter$ldap$options );
 8.  
 9.  // alternatively, you can set the options to an existing filter
10.  $filter new ezcAuthenticationLdapFilter$ldap );
11.  $filter->setOptions$options );

Parents

ezcBaseOptions
   |
   --ezcAuthenticationFilterOptions
      |
      --ezcAuthenticationLdapOptions

Properties

int read/write  $protocol
How to connect to the LDAP server:
  • ezcAuthenticationLdapFilter::PROTOCOL_PLAIN - plain connection
  • ezcAuthenticationLdapFilter::PROTOCOL_TLS - TLS connection

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcAuthenticationLdapOptions __construct( [$options = array()] )
Constructs an object with the specified values.

Inherited Methods

From ezcAuthenticationFilterOptions :
public ezcAuthenticationFilterOptions ezcAuthenticationFilterOptions::__construct()
Constructs an object with the specified values.
From ezcBaseOptions :
public ezcBaseOptions ezcBaseOptions::__construct()
Construct a new options object.
public void ezcBaseOptions::merge()
Merge an array into the actual options object.
public bool ezcBaseOptions::offsetExists()
Returns if an option exists.
public mixed ezcBaseOptions::offsetGet()
Returns an option value.
public void ezcBaseOptions::offsetSet()
Set an option.
public void ezcBaseOptions::offsetUnset()
Unset an option.

Methods

__construct

ezcAuthenticationLdapOptions __construct( [ $options = array()] )
Constructs an object with the specified values.

Parameters

Name Type Description
$options array(string=>mixed) Options for this class

Throws

ClassDescription
ezcBaseValueException if $options contains a property with a value not allowed
ezcBasePropertyNotFoundException if $options contains a property not defined

Redefinition of

Method Description
ezcAuthenticationFilterOptions::__construct() Constructs an object with the specified values.

Last updated: Mon, 21 Dec 2009