Reference

API overview

Configuration options

Zend\Ldap\Ldap accepts an array of options either supplied to the constructor or through the setOptions() method. The permitted options are as follows:

API Reference

Class names are relative to the Zend\Ldap namespace, unless otherwise noted.

Zend\Ldap\Ldap

Zend\Ldap\Ldap is the base interface into a LDAP server. It provides connection and binding methods as well as methods to operate on the LDAP tree.

search()

The search() signature is as follows:

search(
    string|Filter\AbstractFilter $filter,
    string|Dn $basedn,
    int $scope,
    array $attributes,
    string $sort,
    string $collectionClass,
    int $sizelimit,
    int $timelimit
) : Collection

where:

• $filter: The filter string to be used in the search, e.g. (objectClass=posixAccount).
• $basedn: The search base for the search. If omitted or null, the baseDn from the connection and binding parameters is used.
• $scope: The search scope:
  • Ldap::SEARCH_SCOPE_SUB searches the complete subtree including the $baseDn node. This is the default value.
  • Ldap::SEARCH_SCOPE_ONE restricts search to one level below $baseDn.
  • Ldap::SEARCH_SCOPE_BASE restricts search to the $baseDn itself; this can be used to efficiently retrieve a single entry by its DN.
• $attributes: Specifies the attributes contained in the returned entries. To include all possible attributes (ACL restrictions can disallow certain attribute to be retrieved by a given user), pass either an empty array ([]) or an array containing a wildcard (['*']) to the method. On some LDAP servers, you can retrieve special internal attributes by passing ['*', '+'] to the method.
• $sort: If given, the result collection will be sorted according to the attribute $sort. Results can only be sorted after one single attribute as this parameter uses the ext/ldap function ldap_sort().
• $collectionClass: If given, the result will be wrapped in an object of type $collectionClass. By default, an object of type Zend\Ldap\Collection will be returned. The custom class must extend Zend\Ldap\Collection, and will be passed a Zend\Ldap\Collection\Iterator\Default on instantiation.
• $sizelimit: Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
• $timelimit: Sets the maximum number of seconds to spend on the search. Setting this to 0 means no limit.

searchEntries()

searchEntries(
    string|Dn $basedn,
    int $scope,
    array $attributes,
    string $sort,
    bool $reverseSort,
    int $sizelimit,
    int $timelimit
) : array

Arguments are essentially the same as for search(), with two differences:

• $reverseSort: a boolean indicating whether or not the results should be returned in reverse sort order.
• $collectionClass is not present in this signature.

Unlike search(), this method always returns an array of results.

Zend\Ldap\Collection

Zend\Ldap\Collection implements Iterator to allow for item traversal using foreach() and Countable to be able to respond to count(). With its protected createEntry() method, it provides an extension point for developers needing custom result objects.

Zend\Ldap\Attribute

Zend\Ldap\Attribute is a helper class providing only static methods to manipulate arrays suitable to the structure used in Zend\Ldap\Ldap data modification methods, and to the data format required by the LDAP server. PHP data types are converted using Zend\Ldap\Converter\Converter methods.

setPassword()

The full signature of setPassword() is as follows:

static setPassword(
    array &$data,
    string $password,
    string $hashType,
    string $attribName
) : void

Sets an LDAP password for the attribute $attribName in $data. $attribName defaults to userPassword which is the standard password attribute. The password hash can be specified with $hashType. The default value here is Attribute::PASSWORD_HASH_MD5 with Attribute::PASSWORD_HASH_SHA as the other possibility.

setDateTimeAttribute()

The full signature of setDateTimeAttribute() is as follows:

static setDateTimeAttribute(
    array &$data,
    string $attribName,
    int|array $value,
    boolean $utc,
    boolean $append
) : void

Sets the attribute $attribName in $data to the date/time value $value. if $append is true (false by default) $value will be appended to the attribute. $value can be an integer value or an array of integers. Date-time-conversion according to Converter\Converter::toLdapDateTime() will take place.

getDateTimeAttribute()

The full signature of getDateTimeAttribute() is as follows:

static getDateTimeAttribute(
    array $data,
    string $attribName,
    int|null $index
) : array|int

Returns the date/time attribute $attribName from $data. If $index is null (default), an array will be returned containing all the date/time values for the given attribute. An empty array will be returned if the attribute does not exist in the given array. If an integer index is specified the corresponding date/time value at the given index will be returned. If the index is out of bounds, null will be returned. Date-time-conversion according to Converter\Converter::fromLdapDateTime() will take place.

Zend\Ldap\Converter\Converter

Zend\Ldap\Converter\Converter is a helper class providing only static methods to manipulate arrays suitable to the data format required by the LDAP server. PHP data types are converted the following way:

• string: No conversion will be done.
• integer and float: The value will be converted to a string.
• boolean: true will be converted to 'TRUE' and false to 'FALSE'.
• object and array: The value will be converted to a string by using serialize().
• Date/Time: The value will be converted to a string with the following date() format YmdHisO, UTC timezone (+0000) will be replaced with a Z. For example 01-30-2011 01:17:32 PM GMT-6 will be 20113001131732-0600 and 30-01-2012 15:17:32 UTC will be 20120130151732Z.
• resource: If a stream resource is given, the data will be fetched by calling stream_get_contents().
• Others: All other data types (namely non-stream resources) will be omitted.

On reading values, the following conversion will take place:

• 'TRUE': Converted to true.
• 'FALSE': Converted to false.
• Others: All other strings won't be automatically converted and are passed as they are.

Zend\Ldap\Dn

Zend\Ldap\Dn provides an object-oriented interface to manipulating LDAP distinguished names (DN). The parameter $caseFold that is used in several methods determines the way DN attributes are handled regarding their case. Allowed values for this parameter are:

• Dn::ATTR_CASEFOLD_NONE: No case-folding will be done.
• Dn::ATTR_CASEFOLD_UPPER: All attributes will be converted to upper-case.
• Dn::ATTR_CASEFOLD_LOWER: All attributes will be converted to lower-case.

The default case-folding is Dn::ATTR_CASEFOLD_NONE; set an alternative with Dn::setDefaultCaseFold(). Each instance of Zend\Ldap\Dn can have its own case-folding setting. If the $caseFold parameter is omitted in method-calls it defaults to the instance's case-folding setting.

The class implements ArrayAccess to allow indexer-access to the different parts of the DN. The ArrayAccess methods proxy to Dn::get($offset, 1, null) for offsetGet(int $offset), to Dn::set($offset, $value) for offsetSet(), and to Dn::remove($offset, 1) for offsetUnset(). offsetExists() simply checks if the index is within the bounds.

Zend\Ldap\Filter

Zend\Ldap\Node

Zend\Ldap\Node includes the magic property accessors __set(), __get(), __unset(), and __isset() for accessing the attributes by name. They proxy to Node::setAttribute(), Node::getAttribute(), Node::deleteAttribute(), and Node::existsAttribute() respectively. Furthermore the class implements ArrayAccess for array-style access to the attributes. Zend\Ldap\Node also implements Iterator and RecursiveIterator to allow for recursive tree-traversal.

Node constructor

The full signature of the Zend\Ldap\Node constructor is:

__construct(
    string $attr,
    string $value,
    string $filtertype,
    string|null $prepend,
    string|null $append
) : void

The resulting filter will be a concatenation of $attr, $filtertype, $prepend, $value, and $append. Normally this constructor is not needed, as all filters can be created by using the appropriate factory methods.

Zend\Ldap\Node\RootDse

The following methods are available on all vendor-specific subclasses.

Zend\Ldap\Node\RootDse includes the magic property accessors __get() and __isset() to access the attributes by their name. They proxy to Node\RootDse::getAttribute() and Node\RootDse::existsAttribute() respectively. __set() and __unset() are also implemented but they throw a BadMethodCallException, as modifications are not allowed on RootDSE nodes. Furthermore the class implements ArrayAccess for array-style access to the attributes. offsetSet() and offsetUnset() also throw a BadMethodCallException.

OpenLDAP

Additionally the common methods above apply to instances of Zend\Ldap\Node\RootDse\OpenLdap.

Refer to LDAP Operational Attributes and Objects specification for information on the attributes of OpenLDAP RootDSE.

ActiveDirectory

Additionally the common methods above apply to instances of Zend\Ldap\Node\RootDse\ActiveDirectory.

Refer to the RootDSE specification for information on the attributes of Microsoft ActiveDirectory RootDSE.

eDirectory

Additionally the common methods above apply to instances of Zend\Ldap\Node\RootDse\eDirectory.

Refer to Getting Information about the LDAP Server for information on the attributes of Novell eDirectory RootDSE.

Zend\Ldap\Node\Schema

The following methods are available on all vendor-specific subclasses.

Zend\Ldap\Node\Schema includes the magic property accessors __get() and __isset() to access the attributes by their name. They proxy to Schema::getAttribute() and Schema::existsAttribute() respectively. __set() and __unset() are also implemented, but they throw a BadMethodCallException, as modifications are not allowed on RootDSE nodes. Furthermore the class implements ArrayAccess for array-style access to the attributes. offsetSet() and offsetUnset() also throw a BadMethodCallException.

AttributeTypeInterface

ObjectClassInterface

AbstractItem

Classes representing attribute types and object classes extend Zend\Ldap\Node\Schema\AbstractItem, which provides some core methods to access arbitrary attributes on the underlying LDAP node. AbstractItem includes the magic property accessors __get() and __isset() to access the attributes by their name. Furthermore the class implements ArrayAccess for array-style-access to the attributes. offsetSet() and offsetUnset() throw a BadMethodCallException, as modifications are not allowed on schema information nodes.

OpenLDAP

Additionally the common methods above apply to instances of Zend\Ldap\Node\Schema\OpenLDAP.

Zend\Ldap\Node\Schema\AttributeType\OpenLDAP has the following API:

Zend\Ldap\Node\Schema\ObjectClass\OpenLDAP has the following API:

ActiveDirectory

Schema browsing on ActiveDirectory servers

Due to restrictions on Microsoft ActiveDirectory servers regarding the number of entries returned by generic search routines, and due to the structure of the ActiveDirectory schema repository, schema browsing is currently not available for Microsoft ActiveDirectory servers.

None of Zend\Ldap\Node\Schema\ActiveDirectory, Zend\Ldap\Node\Schema\AttributeType\ActiveDirectory, or Zend\Ldap\Node\Schema\\ObjectClass\ActiveDirectory provide additional methods.

Zend\Ldap\Ldif\Encoder

The $options argument to encode() may contain the following keys:

• sort: Sort the given attributes with dn following objectClass, and following all other attributes sorted alphabetically. true by default.
• version: The LDIF format version. 1 by default.
• wrap: The line-length. 78 by default to conform to the LDIF specification.