Zend Framework: Zend_Ldap_Ext Component Proposal

Proposed Component Name	Zend_Ldap_Ext
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Ldap_Ext
Proposers	Stefan Gehrig Liasion: Ralph Schindler
Revision	0.1 - 29 March 2008: Opened proposal. 0.1.1 - 3 April 2008: Changed layout to use decks. 0.2 - 13 April 2008: Added Zend_Ldap_Ext::count() method 0.3 - 17 April 2008: Completely reworked the class skeletons to match the current version, I'm working on. 0.4 - 5 July 2008: Changed respository location 0.5 - 10 August 2008: Reworked the proposal as it was fairly outdated (wiki revision: 25)

The existing Zend_Ldap component currently just responds to authentication use cases in all their varieties. There is no posibility to query a LDAP directory service in a unified and consistent way. The current component also lacks core CRUD (Create, Retrieve, Update and Delete) functionality - operations that are crucial to for example database abstraction layers.
This proposals tries to resolve these deficiencies in that it provides a simple two-ply object oriented model to connect to, query and perfom CRUD operations on an LDAP server. The first layer is a wrapper around the ext/ldap functions, spiced up with extended functionality such as copying and moving (renaming in a LDAP context) nodes and subtrees.
The second layer (Zend_Ldap_Node) provides an active-record-like interface to LDAP entries and stresses the tree-structure of LDAP data in providing (recursive) tree traversal methods.
To simplify the usage of the unfamiliar LDAP filter syntax this components proposes an object oriented approach to LDAP filter string generation, which can loosely be compared to Zend_Db_Select.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

This component will extend Zend_Ldap.
This component will provide generic search functions.
This component will provide generic CRUD functions (add(), update() and delete()).
This component will contain a query result class to abstract the cumbersome use of ext/ldap to retrieve attributes in a common format.
This component will assist the user in populating and reading LDAP entry arrays.
This component will detect LDAP boolean values ('TRUE' and 'FALSE') and convert them to PHP booleans.
This component will provide a method to populate an LDAP entry array regardless of the PHP variable type.
This component will handle file resources transparently so that it's possible to add the contents of a file to an LDAP attribute.
This component will provide a method to set a LDAP userPassword attribute with SHA1 or MD5 hashed passwords.

4. Dependencies on Other Framework Components

Zend_Ldap
PHP ext/ldap

5. Theory of Operation

The Zend_Ldap_Ext component extends Zend_Ldap with methods to query an LDAP directory service and to perform creation, updating, retrieval and deletion operations on the LDAP server. It therefore wraps ext/ldap function calls in an object-oriented interface and unifies result handling. On this layer LDAP data is represented in an array format to allow for round-trips of the data. Helper functions will allow developers to handle LDAP data in a common way; this includes conversion of LDAP date/time attributes, LDAP boolean attributes and the creation of LDAP password attributes. These methods will also help the developer to build consistent LDAP data arrays for use with the different data modification methods of Zend_Ldap_Ext and will allow the creation of LDAP DN strings (a lof of these functions are inspired by PEAR::Package::Net_LDAP2).
Query results are encapsulated in Zend_Ldap_QueryResult which acts as an interface to the LDAP resultset. Zend_Ldap_QueryResult implemets the common PHP SPL interfaces Iterator and Countable and includes a LDAP entry cache to speed up multiple iterations.
On top of these core functionality Zend_Ldap_Node provides an active-record-like interface to single LDAP entries. Through the use of the SPL RecursiveIterator interface developers can traverse complete LDAP trees recursively with a single foreach()-loop. Zend_Ldap_Node can be extended by deleopers and form a basis for a LDAP data model.
Building LDAP filter strings is unfamiliar to SQL-accustomed developers and not always very intuitive with all its parentheses. Zend_Ldap_Filter proposes an object oriented approach to filter creation which is also inspired by PEAR::Package::Net_LDAP2. With automatic value escaping LDAP filter string creation could be a no-brainer this way.

6. Milestones / Tasks

Milestone 1: [DONE] Write initial proposal
Milestone 2: [CURRENT] Review by community
Milestone 3: [DONE] Checked in at http://svn2.assembla.com/svn/zf-proposals/trunk
Milestone 4: Review by Zend
Milestone 5: Component incubated
Milestone 6: [DONE] Write unit tests
Milestone 7: Write documentation
Milestone 8: Component cored

7. Class Index

Zend_Ldap_Ext
Zend_Ldap_Filter
Zend_Ldap_Filter_Abstract
Zend_Ldap_Filter_And
Zend_Ldap_Filter_Exception
Zend_Ldap_Filter_Logical
Zend_Ldap_Filter_Mask
Zend_Ldap_Filter_Not
Zend_Ldap_Filter_Or
Zend_Ldap_Filter_String
Zend_Ldap_Helper
Zend_Ldap_Node
Zend_Ldap_Node_AttributeIterator
Zend_Ldap_Node_Children
Zend_Ldap_QueryResult

8. Use Cases

Core classes

Search a LDAP diretory service

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$result=$ldap->search('(objectclass=*)', 'ou=People,dc=my,dc=local', Zend_Ldap_Ext::SEARCH_SCOPE_ONE);
foreach ($result as $item)
{
    echo $item["dn"] . ': ' . $item['cn'][0] . PHP_EOL;
}

Retrieve a single entry by its DN

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$hm=$ldap->getEntry('cn=Hugo Müller,ou=People,dc=my,dc=local');
/*
$hm is an array of the following structure
array(
    'dn'          => 'cn=Hugo Müller,ou=People,dc=my,dc=local',
    'cn'          => array('Hugo Müller'),
    'sn'          => array('Müller'),
    'objectclass' => array('inetOrgPerson', 'top'),
    ...
)
*/

Add a new entry to LDAP directory

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$entry=array();
Zend_Ldap_Helper::setAttribute($entry, 'cn', 'Hans Meier');
Zend_Ldap_Helper::setAttribute($entry, 'sn', 'Meier');
Zend_Ldap_Helper::setAttribute($entry, 'objectClass', 'inetOrgPerson');
$ldap->add('cn=Hans Meier,ou=People,dc=my,dc=local', $entry);

Delete an entry from LDAP directory

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$ldap->delete('cn=Hans Meier,ou=People,dc=my,dc=local');

Load an entry from LDAP directory, change attribute, set password
and update to LDAP directory

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$hm=$ldap->getEntry('cn=Hugo Müller,ou=People,dc=my,dc=local');
Zend_Ldap_Helper::setAttribute($hm, 'mail', 'mueller@my.local');
Zend_Ldap_Helper::setPassword($hm, 'newPa$$w0rd', Zend_Ldap_Helper::PASSWORD_HASH_SHA1);
$ldap->update('cn=Hugo Müller,ou=People,dc=my,dc=local', $hm);

Check for the existence of a given DN

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$isThere=$ldap->exists('cn=Hugo Müller,ou=People,dc=my,dc=local');

Count children of a given DN

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$childrenCount=$ldap->countChildren('cn=Hugo Müller,ou=People,dc=my,dc=local');

Copy a LDAP entry recursively with all its descendants.

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$ldap->copy('cn=Hugo Müller,ou=People,dc=my,dc=local', 'cn=Hans Meier,ou=People,dc=my,dc=local', true);

Move a LDAP entry recursively with all its descendants to a different subtree.

$options = array(/* same as in Zend_Ldap */);
$ldap=new Zend_Ldap_Ext($options);
$ldap->bind();
$ldap->moveToSubtree('cn=Hugo Müller,ou=People,dc=my,dc=local', 'ou=Dismissed,dc=my,dc=local', true);

Filter subpackage

Node subpackage

9. Class Skeletons

Core classes

/**
 * Zend_Ldap_Ext provides extended access to LDAP server.
 * 
 * Zend_Ldap_Ext extends Zend_Ldap with search and modify capabilities
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Ext extends Zend_Ldap
{
	const SEARCH_SCOPE_SUB=1;
    const SEARCH_SCOPE_ONE=2;
    const SEARCH_SCOPE_BASE=3;
    
    /**
     * @param  array|Zend_Config $options Options used in connecting, binding, etc.
     */
    public function __construct($options=array())
    {}
    
	public function __destruct()
	{}
	
    /**
     * Gets the base DN under which objects of interest are located
     * 
     * @return string 
     */
    public function getBaseDn()
    {}
    
	/**
     * A global LDAP search routine for finding information.
     *
     * @param string $filter
     * @param string $base_dn
     * @param integer $scope
     * @param array $attributes
     * @param string $sort
     * @return Zend_Ldap_QueryResult 
     * @throws Zend_Ldap_Exception
     */ 
    public function search($filter, $basedn=null, $scope=self::SEARCH_SCOPE_SUB, 
    	array $attributes=array(), $sort=null) 
    {} 
    
    /**
     * Count items found by given filter.
     *
     * @param string $filter
     * @param string $base_dn
     * @param integer $scope
     * @return integer 
     * @throws Zend_Ldap_Exception
     */ 
    public function count($filter, $basedn=null, $scope=self::SEARCH_SCOPE_SUB) 
    {} 
    
    /**
     * Count children for a given DN.
     *
     * @param string $dn
     * @return integer 
     * @throws Zend_Ldap_Exception
     */ 
    public function countChildren($dn) 
    {}
    
    /**
     * Check if a given DN exists.
     *
     * @param string $dn
     * @return boolean 
     * @throws Zend_Ldap_Exception
     */ 
    public function exists($dn) 
    {} 
     
    /**
     * Search LDAP registry for entries matching filter and optional attributes
     *
     * @param string $filter
     * @param string $base_dn
     * @param integer $scope
     * @param array $attributes
     * @param string $sort
     * @return array 
     * @throws Zend_Ldap_Exception
     */ 
    public function searchEntries($filter, $basedn=null, $scope=self::SEARCH_SCOPE_SUB, 
    	array $attributes=array(), $sort=null) 
    {}
    
    /**
     * Get LDAP entry by DN
     *
     * @param string $dn
     * @param array $attributes
     * @param boolean $throwOnNotFound
     * @return array
     * @throws Zend_Ldap_Exception
     */
    public function getEntry($dn, array $attributes=array(), $throwOnNotFound=false)
    {}
    
    /**
     * Prepares an ldap data entry array for insert/update operation
     *
     * @param array $entry
     * @return void
     * @throws InvalidArgumentException
     */
    public static function prepareLdapEntryArray(array &$entry)
    {}
     
    /**
     * Add new information to the LDAP repository
     * 
     * @param string $dn
     * @param array $entry
     * @return Zend_Ldap_Ext *Provides a fluid interface* 
     * @throws Zend_Ldap_Exception
     */ 
    public function add($dn, array $entry) 
    {} 
     
    /**
     * Update LDAP registry
     * 
     * @param string $dn
     * @param array $entry
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */ 
    public function update($dn, array $entry) 
    {} 
    
    /**
     * Save entry to LDAP registry.
     * 
     * Internally decides if entry will be updated to added by calling
     * {@link exists()}.
     * 
     * @param string $dn
     * @param array $entry
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */ 
    public function save($dn, array $entry) 
    {} 
     
    /**
     * Delete an LDAP entry
     *
     * @param  string $dn
     * @param  boolean $recursively
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */ 
    public function delete($dn, $recursively=false) 
    {}
    
    /**
     * Moves a LDAP entry from one DN to another subtree.
     *
     * @param string $from
     * @param string $to
     * @param boolean $recursively
     * @param boolean $alwaysEmulate
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function moveToSubtree($from, $to, $recursively=false, $alwaysEmulate=false)
    {}
    
    /**
     * Moves a LDAP entry from one DN to another DN.
     * 
     * This is an alias for {@link rename()}
     *
     * @param string $from
     * @param string $to
     * @param boolean $recursively
     * @param boolean $alwaysEmulate
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function move($from, $to, $recursively=false, $alwaysEmulate=false)
    {}
    
    /**
     * Renames a LDAP entry from one DN to another DN.
     * 
     * This method implicitely moves the entry to another location within the tree.
     *
     * @param string $from
     * @param string $to
     * @param boolean $recursively
     * @param boolean $alwaysEmulate
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function rename($from, $to, $recursively=false, $alwaysEmulate=false)
    {}
    
    /**
     * Copies a LDAP entry from one DN to another subtree.
     *
     * @param string $from
     * @param string $to
     * @param boolean $recursively
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function copyToSubtree($from, $to, $recursively=false)
    {}
    
    /**
     * Copies a LDAP entry from one DN to another DN.
     *
     * @param string $from
     * @param string $to
     * @param boolean $recursively
     * @return Zend_Ldap_Ext *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function copy($from, $to, $recursively=false)
    {}
    
    /**
     * Returns the specified DN as a Zend_Ldap_Node
     *
     * @param  string $dn
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public function getNode($dn)
    {}
    
    /**
     * Returns the base node as a Zend_Ldap_Node
     *
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public function getBaseNode()
    {}
}

/**
 * Zend_Ldap_QueryResult wraps query results.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_QueryResult implements Iterator, Countable
{
	/**
	 * LDAP Connection
	 *
	 * @var Zend_Ldap
	 */
	protected $_ldap=null;
	
	/**
	 * Result identifier resource
	 *
	 * @var resource
	 */
	protected $_resultId=null;
	
	/**
	 * Current result entry identifier
	 *
	 * @var resource
	 */
	protected $_current=null;
	
	/**
	 * Current item number
	 *
	 * @var integer
	 */
	protected $_currentNumber=-1;
	
	/**
	 * Number of items in query result
	 *
	 * @var integer
	 */
	protected $_itemCount=-1;
	
	/**
	 * Container for item caching to speed up multiple iterations
	 *
	 * @var array
	 */
	protected $_cache=array();
	
	public function __construct(Zend_Ldap $ldap, $resultId)
	{}
	
	public function __destruct()
	{}
    
    /**
     * Closes the current result set
     *
     * @return bool
     */
    public function close()
    {}
    
    /**
     * Get all entries as an array
     * 
     * @return array
     */
    public function toArray()
    {}
    
	/**
     * Get first entry
     * 
     * @return array
     */
    public function getFirst()
    {}
    
    /**
     * Returns the number of items in current result
     * Implements Countable
     *
     * @return int
     */
    public function count()
    {}
    
    /**
	 * Return the current result item
	 * Implements Iterator
	 *
	 * @return array
	 * @throws Zend_Ldap_Exception
	 */
    public function current()
    {}
    
	/**
	 * Return the result item key
	 * Implements Iterator
	 *
	 * @return int
	 */
	public function key()
    {}
    
	/**
	 * Move forward to next result item
	 * Implements Iterator
	 *
	 * @throws Zend_Ldap_Exception
	 */
	public function next()
    {}
    
	/**
	 * Rewind the Iterator to the first result item
	 * Implements Iterator
	 *
	 * @throws Zend_Ldap_Exception
	 */
	public function rewind()
    {}
    
	/**
	 * Check if there is a current result item
	 * after calls to rewind() or next()
	 * Implements Iterator
	 *
	 * @return bool
	 */
	public function valid()
    {}
}

/**
 * Zend_Ldap_Helper is a collection of useful LDAP related functions.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Helper
{
	const PASSWORD_HASH_MD5='md5';
	const PASSWORD_HASH_SHA='sha1';
	
	const RDN_ATTR_CASEFOLD_NONE='none';
	const RDN_ATTR_CASEFOLD_UPPER='upper';
	const RDN_ATTR_CASEFOLD_LOWER='lower';
	
	/**
	 * Sets a LDAP attribute.
	 *
	 * @param  array $data
	 * @param  string $attribName
	 * @param  mixed $value
	 * @param  bool $append
	 * @param  string $encoding
	 * @return void
	 */
	public static function setAttribute(array &$data, $attribName, $value, 
		$append=false, $encoding='UTF-8')
	{}
	
	/**
	 * Gets a LDAP attribute.
	 *
	 * @param  array $data
	 * @param  string $attribName
	 * @param  integer $index
	 * @param  string $encoding
	 * @return array|mixed
	 */
	public static function getAttribute(array $data, $attribName, $index=null, $encoding='UTF-8')
	{}
	
	/**
	 * Remove given values from a LDAP attribute
	 *
	 * @param array $data
	 * @param string $attribName
	 * @param mixed|array $value
	 * @param string $encoding
	 * @return void
	 */
	public static function removeFromAttribute(array &$data, $attribName, $value, $encoding='UTF-8')
	{}
	
	private static function _valueToLdap($value)
	{}
	
    private static function _valueFromLdap($value)
    {}
	
	/**
	 * Converts a PHP data type into its LDAP representation
	 *
	 * @param mixed $value
	 * @return string|null - null if the PHP data type cannot be converted.
	 */
	public static function convertToLdapValue($value)
	{}
	
    /**
     * Converts an LDAP value into its PHP data type
     *
     * @param string $value
     * @return mixed
     */
    public static function convertFromLdapValue($value)
    {}
    
    /**
     * Converts a timestamp into its LDAP date/time representation
     *
     * @param integer $value
     * @param boolean $utc
     * @return string|null - null if the value cannot be converted.
     */
    public static function convertToLdapDateTimeValue($value, $utc=false)
    {}
    
    /**
     * Converts LDAP date/time representation into a timestamp
     *
     * @param string $value
     * @return integer|null - null if the value cannot be converted.
     */
    public static function convertFromLdapDateTimeValue($value)
    {}
	
	/**
	 * Sets a LDAP password.
	 *
	 * @param  array $data
	 * @param  string $password
	 * @param  string $hashType
	 * @param  string $attribName
	 * @param  string $encoding
	 * @return null
	 */
	public static function setPassword(array &$data, $password, $hashType=self::PASSWORD_HASH_MD5,
		$attribName='userPassword', $encoding='UTF-8')
	{}
	
	/**
     * Creates a LDAP password.
     *
     * @param  string $password
     * @param  string $hashType
     * @return string
     */
	public static function createPassword($password, $hashType=self::PASSWORD_HASH_MD5)
	{}
	
    /**
     * Sets a LDAP date/time attribute.
     *
     * @param  array $data
     * @param  string $attribName
     * @param  integer|array $value
     * @param  bool $utc
     * @param  bool $append
     * @param  string $encoding
     * @return null
     */
    public static function setDateTimeAttribute(array &$data, $attribName, $value, $utc=false, 
        $append=false, $encoding='UTF-8')
    {}
    
    private static function _valueToLdapDateTime($value, $utc)
    {}
    
    /**
     * Gets a LDAP date/time attribute.
     *
     * @param  array $data
     * @param  string $attribName
     * @param  integer $index
     * @param  string $encoding
     * @return array|integer
     */
    public static function getDateTimeAttribute(array $data, $attribName, $index=null, $encoding='UTF-8')
    {}
    
    private static function _valueFromLdapDateTime($value)
    {}
    
    /**
     * Creates an array containing all parts of the given DN.
     *
     * Array will be of type
     * array(
     *      array("cn", "name1"),
     *      array("cn", "name2"),
     *      array("dc", "example"),
     *      array("dc", "org")
     * )
     * for a DN of cn=name1,cn=name2,dc=example,dc=org.
     * 
     * @uses   Zend_Ldap::explodeDn()
     * @param  string $dn
     * @param  array  $keys An optional array to receive DN keys (e.g. CN, OU, DC, ...)
     * @param  array  $vals An optional array to receive DN values
     * @return array
     * @throws Zend_Ldap_Exception
     */
    public static function explodeDn($dn, array &$keys = null, array &$vals = null)
    {}
    
    /**
     * Returns a DN part in the form $attribute=$value
     * 
     * This method supports the creation of multi-valued RDNs
     * $part must contain an even number of elemets.
     *
     * @param  array $attribute
     * @param  string $caseFold
     * @param  string $encoding
     * @return string
     * @throws Zend_Ldap_Exception
     */

    public static function implodeRdn(array $part, $caseFold=self::RDN_ATTR_CASEFOLD_NONE, $encoding='UTF-8')
    {}
    
    /**
     * Implodes an array in the form delivered by {@link explodeDn()}
     * to a DN string.
     * 
     * $dnArray must be of type
     * array(
     *      array("cn", "name1"),
     *      array("cn", "name2"),
     *      array("dc", "example"),
     *      array("dc", "org")
     * )
     *
     * @param  array $dnArray
     * @param  string $caseFold
     * @param  string $separator
     * @param  string $encoding
     * @return string
     * @throws Zend_Ldap_Exception
     */
    public static function implodeDn(array $dnArray, $caseFold=self::RDN_ATTR_CASEFOLD_NONE, 
        $separator=',', $encoding='UTF-8')
    {}
    
    /**
     * Checks if given $childDn is beneath $parentDn subtree.
     *
     * @param  string $childDn
     * @param  string $parentDn
     * @return boolean
     */
    public static function isChildOf($childDn, $parentDn)
    {}
    
    /**
     * Escapes the given VALUES according to RFC 2254 so that they can be safely used in LDAP filters.
     *
     * Any control characters with an ACII code < 32 as well as the characters with special meaning in
     * LDAP filters "*", "(", ")", and "\" (the backslash) are converted into the representation of a
     * backslash followed by two hex digits representing the hexadecimal value of the character.
     * @see Net_LDAP2_Util::escape_filter_value() from Benedikt Hallinger <beni@php.net>
     * @link http://pear.php.net/package/Net_LDAP2
     * @author Benedikt Hallinger <beni@php.net>
     *
     * @param  string|array $values Array of values to escape
     * @return array Array $values, but escaped
     */
    public static function escapeFilterValue($values=array())
    {}

    /**
     * Undoes the conversion done by {@link escapeFilterValues()}.
     *
     * Converts any sequences of a backslash followed by two hex digits into the corresponding character.
     * @see Net_LDAP2_Util::escape_filter_value() from Benedikt Hallinger <beni@php.net>
     * @link http://pear.php.net/package/Net_LDAP2
     * @author Benedikt Hallinger <beni@php.net>
     *
     * @param  string|array $values Array of values to escape
     * @return array Array $values, but unescaped
     */
    public static function unescapeFilterValue($values=array())
    {}
    
    /**
     * Escapes a DN value according to RFC 2253
     *
     * Escapes the given VALUES according to RFC 2253 so that they can be safely used in LDAP DNs.
     * The characters ",", "+", """, "\", "<", ">", ";", "#", "=" with a special meaning in RFC 2252
     * are preceeded by ba backslash. Control characters with an ASCII code < 32 are represented as \hexpair.
     * Finally all leading and trailing spaces are converted to sequences of \20.
     * @see Net_LDAP2_Util::escape_dn_value() from Benedikt Hallinger <beni@php.net>
     * @link http://pear.php.net/package/Net_LDAP2
     * @author Benedikt Hallinger <beni@php.net>
     *
     * @param  string|array $values An array containing the DN values that should be escaped
     * @return array The array $values, but escaped
     */
    public static function escapeDnValue($values=array())
    {}

    /**
     * Undoes the conversion done by {@link escapeDnValues()}.
     *
     * Any escape sequence starting with a baskslash - hexpair or special character -
     * will be transformed back to the corresponding character.
     * @see Net_LDAP2_Util::escape_dn_value() from Benedikt Hallinger <beni@php.net>
     * @link http://pear.php.net/package/Net_LDAP2
     * @author Benedikt Hallinger <beni@php.net>
     *
     * @param  string|array $values Array of DN Values
     * @return array Same as $values, but unescaped
     */
    public static function unescapeDnValue($values=array())
    {}
    
    /**
     * Converts all ASCII chars < 32 to "\HEX"
     *
     * @see Net_LDAP2_Util::asc2hex32() from Benedikt Hallinger <beni@php.net>
     * @link http://pear.php.net/package/Net_LDAP2
     * @author Benedikt Hallinger <beni@php.net>
     * 
     * @param  string $string String to convert
     * @return string
     */
    public static function ascToHex32($string)
    {}

    /**
     * Converts all Hex expressions ("\HEX") to their original ASCII characters
     *
     * @see Net_LDAP2_Util::hex2asc() from Benedikt Hallinger <beni@php.net>,
     * heavily based on work from DavidSmith@byu.net
     * @link http://pear.php.net/package/Net_LDAP2
     * @author Benedikt Hallinger <beni@php.net>, heavily based on work from DavidSmith@byu.net
     * 
     * @param  string $string String to convert
     * @return string
     */
    public static function hex32ToAsc($string)
    {}
}

Filter subpackage

/**
 * Zend_Ldap_Filter.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter extends Zend_Ldap_Filter_String 
{
    const TYPE_EQUALS='=';
    const TYPE_GREATER='>';
    const TYPE_GREATEROREQUAL='>=';
    const TYPE_LESS='<';
    const TYPE_LESSOREQUAL='<=';
    const TYPE_APPROX='~=';
	
	/**
	 * Creates an 'equals' filter.
	 * (attr=value)
	 *
	 * @param  string $attr
	 * @param  string $value
	 * @return Zend_Ldap_Filter
	 */
	public static function equals($attr, $value)
	{}
	
    /**
     * Creates a 'begins with' filter.
     * (attr=value*)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function begins($attr, $value)
    {}
    
    /**
     * Creates an 'ends with' filter.
     * (attr=*value)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function ends($attr, $value)
    {}
    
    /**
     * Creates a 'contains' filter.
     * (attr=*value*)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function contains($attr, $value)
    {}
    
    /**
     * Creates a 'greater' filter.
     * (attr>value)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function greater($attr, $value)
    {}
    
    /**
     * Creates a 'greater or equal' filter.
     * (attr>=value)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function greaterOrEqual($attr, $value)
    {}
    
    /**
     * Creates a 'less' filter.
     * (attr<value)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function less($attr, $value)
    {}
    
    /**
     * Creates an 'less or equal' filter.
     * (attr<=value)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function lessOrEqual($attr, $value)
    {}
    
    /**
     * Creates an 'approx' filter.
     * (attr~=value)
     *
     * @param  string $attr
     * @param  string $value
     * @return Zend_Ldap_Filter
     */
    public static function approx($attr, $value)
    {}
    
    /**
     * Creates an 'any' filter.
     * (attr=*)
     *
     * @param  string $attr
     * @return Zend_Ldap_Filter
     */
    public static function any($attr)
    {}
    
    /**
     * Creates a simple custom string filter.
     *
     * @param  string $filter
     * @return Zend_Ldap_Filter_String
     */
    public static function string($filter)
    {}
    
    /**
     * Creates a simple string filter to be used with a mask.
     *
     * @param string $mask
     * @param string $value
     * @return Zend_Ldap_Filter_Mask
     */
    public static function mask($mask, $value)
    {}
    
    /**
     * Creates an 'and' filter.
     *
     * @param  Zend_Ldap_Filter_Abstract $filter,...
     * @return Zend_Ldap_Filter_And
     */
    public static function andFilter($filter)
    {}
    
    /**
     * Creates an 'or' filter.
     *
     * @param  Zend_Ldap_Filter_Abstract $filter,...
     * @return Zend_Ldap_Filter_Or
     */
    public static function orFilter($filter)
    {}
	
	/**
	 * Create a filter string.
	 *
	 * @param  string $attr
	 * @param  string $value
	 * @param  string $filtertype
	 * @param  string $prepend
	 * @param  string $append
	 * @return string
	 */
	private static function _createFilterString($attr, $value, $filtertype, $prepend=null, $append=null)
	{}
	
	/**
	 * Creates a new Zend_Ldap_Filter.
	 *
	 * @param string $attr
     * @param string $value
     * @param string $filtertype
     * @param string $prepend
     * @param string $append
	 */
	public function __construct($attr, $value, $filtertype, $prepend=null, $append=null)
	{}
}

/**
 * Zend_Ldap_Filter_Abstract provides a base implementation for filters.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
abstract class Zend_Ldap_Filter_Abstract 
{
    /**
     * Returns a string representation of the filter.
     *
     * @return string
     */
    abstract public function toString();
    
    /**
     * Returns a string representation of the filter.
     * @see toString()
     *
     * @return string
     */
    public function __toString()
    {}
    
    /**
     * Negates the filter.
     *
     * @return Zend_Ldap_Filter_Abstract
     */
    public function negate()
    {}
    
    /** 
     * Creates an 'and' filter.
     *
     * @param  Zend_Ldap_Filter_Abstract $filter,...
     * @return Zend_Ldap_Filter_And
     */
    public function addAnd($filter)
    {}
    
    /**
     * Creates an 'or' filter.
     *
     * @param  Zend_Ldap_Filter_Abstract $filter,...
     * @return Zend_Ldap_Filter_Or
     */
    public function addOr($filter)
    {}
}

/**
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter_Exception extends Zend_Exception
{
}

/**
 * Zend_Ldap_Filter_Logical provides a base implementation for a grouping filter.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
abstract class Zend_Ldap_Filter_Logical extends Zend_Ldap_Filter_Abstract  
{
    const TYPE_AND='&';
    const TYPE_OR='|';
    
    /**
     * All the sub-filters for this grouping filter.
     *
     * @var array
     */
    private $_subfilters;
    
    /**
     * The grouping symbol.
     *
     * @var string
     */
    private $_symbol;
    
    /**
     * Creates a new grouping filter.
     *
     * @param array $subfilters
     * @param string $symbol
     */
    protected function __construct(array $subfilters, $symbol)
    {}
    
    /**
     * Adds a filter to this grouping filter.
     *
     * @param Zend_Ldap_Filter_Abstract $filter
     * @return Zend_Ldap_Filter_Logical 
     */
    public function addFilter(Zend_Ldap_Filter_Abstract $filter)
    {}
    
    /**
     * Returns a string representation of the filter.
     *
     * @return string
     */
    public function toString()
    {}
}

/**
 * Zend_Ldap_Filter_And provides an 'and' filter.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter_And extends Zend_Ldap_Filter_Logical  
{
    /**
     * Creates an 'and' grouping filter.
     *
     * @param array $subfilters
     */
    public function __construct(array $subfilters)
    {}
}

/**
 * Zend_Ldap_Filter_Mask provides a simple string filter to be used with a mask.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter_Mask extends Zend_Ldap_Filter_String  
{
    /**
     * Creates a Zend_Ldap_Filter_String.
     *
     * @param string $mask
     * @param string $value,...
     */
    public function __construct($mask, $value)
    {}
	
	/**
     * Returns a string representation of the filter.
     *
     * @return string
     */
    public function toString()
    {}
}

/**
 * Zend_Ldap_Filter_Not provides a negation filter.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter_Not extends Zend_Ldap_Filter_Abstract  
{
    /**
     * The underlying filter.
     *
     * @var Zend_Ldap_Filter_Abstract
     */
    private $_filter;
    
    /**
     * Creates a Zend_Ldap_Filter_Not.
     *
     * @param Zend_Ldap_Filter_Abstract $filter
     */
    public function __construct(Zend_Ldap_Filter_Abstract $filter)
    {}
    
    /**
     * Negates the filter.
     *
     * @return Zend_Ldap_Filter_Abstract
     */
    public function negate()
    {}
    
    /**
     * Returns a string representation of the filter.
     *
     * @return string
     */
    public function toString()
    {}
}

/**
 * Zend_Ldap_Filter_Or provides an 'or' filter.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter_Or extends Zend_Ldap_Filter_Logical  
{
    /**
     * Creates an 'or' grouping filter.
     *
     * @param array $subfilters
     */
    public function __construct(array $subfilters)
    {}
}

/**
 * Zend_Ldap_Filter_String provides a simple custom string filter.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Filter
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Filter_String extends Zend_Ldap_Filter_Abstract  
{
    /**
     * The filter.
     *
     * @var string
     */
    protected $_filter;
    
    /**
     * Creates a Zend_Ldap_Filter_String.
     *
     * @param string $filter
     */
    public function __construct($filter)
    {}
    
    /**
     * Returns a string representation of the filter.
     *
     * @return string
     */
    public function toString()
    {}
}

Node subpackage

/**
 * Zend_Ldap_Node provides an object oriented view into a LDAP node.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Node implements ArrayAccess, IteratorAggregate, Countable 
{
    /**
     * Holds the node's DN.
     *
     * @var array
     */
    private $_dn;
    /**
     * Holds the node's attributes.
     *
     * @var array
     */
    private $_data;
    /**
     * Holds the node's changed data.
     *
     * @var array
     */
    private $_changed;
    /**
     * Holds the connection to the LDAP server if in connected mode.
     *
     * @var Zend_Ldap_Ext
     */
    private $_ldap;
    /**
     * Caches the child nodes of the current node.
     *
     * @var Zend_Ldap_Node_Children
     */
    private $_children;
    
    /**
     * Creates a new Zend_Ldap_Node
     * 
     * Constructor is private to enforce the use of factory methods.
     *
     * @param  array $data
     * @param  Zend_Ldap_Ext $ldap
     * @throws Zend_Ldap_Exception
     */
    private function __construct(array $data, Zend_Ldap_Ext $ldap=null)
    {}
    
    /**
     * Serialization callback
     *
     * Only node's children and attributes will be serialized.
     * 
     * @return array
     */
    public function __sleep()
    {}
    
    /**
     * Deserialization callback
     *
     * Enforces a detached node.
     * 
     * @return null
     */
    public function __wakeup()
    {}
    
    /**
     * Gets the current LDAP connection.
     * 
     * @return Zend_Ldap_Ext
     * @throws Zend_Ldap_Exception
     */
    public function getLdap()
    {}
    
    /**
     * @param array $data
     * @throws Zend_Ldap_Exception
     */
    private function _loadData(array $data)
    {}
    
    /**
     * Attach node to an LDAP connection
     * 
     * This is an offline method.
     *
     * @uses   Zend_Ldap_Helper::isChildOf()
     * @param  Zend_Ldap_Ext $ldap
     * @return null
     * @throws Zend_Ldap_Exception
     */
    public function attachLdap(Zend_Ldap_Ext $ldap)
    {}
    
    /**
     * Detach node from LDAP connection
     * 
     * This is an offline method.
     * 
     * @return null
     */
    public function detachLdap()
    {}
    
    /**
     * Checks if the current node is attached to a LDAP server.
     *
     * This is an offline method.
     * 
     * @return boolean
     */
    public function isAttached()
    {}
    
    /**
     * Factory method to create a new detached Zend_Ldap_Node for a given DN.
     *
     * @param  string $dn
     * @param  array $objectClass
     * @param  string $encoding
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public static function create($dn, array $objectClass=null, $encoding='UTF-8')
    {}
    
    /**
     * Factory method to create an attached Zend_Ldap_Node for a given DN.
     *
     * @param  string $dn
     * @param  Zend_Ldap_Ext $ldap
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public static function fromLdap($dn, Zend_Ldap_Ext $ldap)
    {}
    
    /**
     * Factory method to create a detached Zend_Ldap_Node from array data.
     *
     * @param  array $data
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public static function fromArray(array $data)
    {}
    
    /**
     * Creates a new node by copying the current node and
     * assigning a new DN.
     *
     * @param string $newDn
     * @param string $encoding
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public function copyNode($newDn, $encoding='UTF-8')
    {}
    
    /**
     * Gets the DN of the current node.
     *
     * This is an offline method.
     * 
     * @return string
     */
    public function getDn()
    {}
    
    /**
     * Gets the DN of the current node as an array.
     *
     * This is an offline method.
     * 
     * @return array
     */
    public function getDnArray()
    {}
    
    /**
     * Gets the DN keys of the current node as an array.
     *
     * This is an offline method.
     * 
     * @return array
     */
    public function getDnKeys()
    {}
    
    /**
     * Gets the DN values of the current node as an array.
     *
     * This is an offline method.
     * 
     * @return array
     */
    public function getDnValues()
    {}
    
    /**
     * Gets the RDN of the current node.
     *
     * This is an offline method.
     * 
     * @return string
     */
    public function getRdn()
    {}
    
    /**
     * Gets node data.
     *
     * The array contains all attributes and the DN with key 'dn'.
     * This is the format used by {@link Zend_Ldap_Helper::getAttribute()}.
     * 
     * This is an offline method.
     * 
     * @return array
     */
    public function getData()
    {}
    
    /**
     * Gets all attributes of node.
     *
     * The array contains all attributes. The DN is stripped from the array.
     * This format can be used in {@link Zend_Ldap_Ext::add()} and {@link Zend_Ldap_Ext::update()},
     * although both methods can be used with {@link getData()} as both methods
     * strip the 'dn' key.
     * 
     * This is an offline method.
     * 
     * @return array
     */
    public function getAttributes()
    {}
    
    /**
     * Gets all attribute keys of node.
     *
     * The array contains all attribute keys. 
     * 
     * This is an offline method.
     * 
     * @return array
     */
    public function getAttributeKeys()
    {}
    
    /**
     * Returns the number of attributes in node.
     * Implements Countable
     * 
     * @return int
     */
    public function count()
    {}
    
    /**
     * Gets changed attributes of node.
     *
     * The array contains all changed attributes. The DN is stripped from the array.
     * This format can be used in {@link Zend_Ldap_Ext::add()} and {@link Zend_Ldap_Ext::update()},
     * although both methods can be used with {@link getChangedData()} as both methods
     * strip the 'dn' key.
     * 
     * This is an offline method.
     * 
     * @return array
     */
    public function getChangedAttributes()
    {}
    
    /**
     * Gets changed node data.
     *
     * The array contains all changed attributes and the DN with key 'dn'.
     * This is the format used by {@link Zend_Ldap_Helper::getAttribute()}.
     * 
     * This is an offline method.
     * 
     * @return array
     */
    public function getChangedData()
    {}
    
    /**
     * Sets a LDAP attribute bypassing attribute checks.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  mixed $value
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception 
     */
    private function _setAttribute($name, $value, $encoding='UTF-8')
    {}
    
    /**
     * Sets a LDAP attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  mixed $value
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception 
     */
    public function setAttribute($name, $value, $encoding='UTF-8')
    {}
    
    /**
     * Appends to a LDAP attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  mixed $value
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception 
     */
    public function appendToAttribute($name, $value, $encoding='UTF-8')
    {}
    
    /**
     * Sets a LDAP date/time attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  integer|array $value
     * @param  bool $utc
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception 
     */
    public function setDateTimeAttribute($name, $value, $utc=false, $encoding='UTF-8')
    {}
    
    /**
     * Appends to a LDAP date/time attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  integer|array $value
     * @param  bool $utc
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception 
     */
    public function appendToDateTimeAttribute($name, $value, $utc=false, $encoding='UTF-8')
    {}
    
    /**
     * Sets a LDAP password.
     *
     * @param  string $password
     * @param  string $hashType
     * @param  string $attribName
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function setPasswordAttribute($password, $hashType=Zend_Ldap_Helper::PASSWORD_HASH_MD5,
        $attribName='userPassword', $encoding='UTF-8')
    {}
    
    /**
     * Deletes (empties) a LDAP attribute.
     * 
     * This method deletes the attribute contents without removing the attribute.
     * If the node is updated on the LDAP server the approrpiate attribute on the LDAP 
     * server gets *deleted*.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function deleteAttribute($name, $encoding='UTF-8')
    {}
    
    /**
     * Removes a LDAP attribute.
     * 
     * This method removes the attribute from the local object.
     * If the node is updated on the LDAP server the approrpiate attribute on the LDAP 
     * server remains untouched. 
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  string $encoding
     * @return Zend_Ldap_Node *Provides a fluid interface*
     * @throws Zend_Ldap_Exception
     */
    public function removeAttribute($name, $encoding='UTF-8')
    {}
    
    /**
     * Checks whether a given attribute exists.
     *
     * If $emptyExists is false empty attributes (containing only array()) are
     * treated as non-existent returning false.
     * If $emptyExists is true empty attributes are treated as existent returning 
     * true. In this case method returns false only if the attribute name is 
     * missing in the key-collection.
     * 
     * @param  string $name
     * @param  boolean $emptyExists
     * @param  string $encoding
     * @return boolean
     */
    public function existsAttribute($name, $emptyExists=false, $encoding='UTF-8')
    {}
    
    /**
     * Gets a LDAP attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  integer $index
     * @param  string $encoding
     * @return mixed 
     * @throws Zend_Ldap_Exception
     */
    public function getAttribute($name, $index=null, $encoding='UTF-8')
    {}
    
    /**
     * Gets a LDAP date/time attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  integer $index
     * @param  string $encoding
     * @return array|integer 
     * @throws Zend_Ldap_Exception
     */
    public function getDateTimeAttribute($name, $index=null, $encoding='UTF-8')
    {}
    
    /**
     * @param  string $name
     * @param  string $encoding
     * @return boolean
     * @throws Zend_Ldap_Exception
     */
    private function _checkAttribute($name, $encoding='UTF-8')
    {}
    
    /**
     * Sets a LDAP attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  mixed $value
     * @return null
     * @throws Zend_Ldap_Exception
     */
    public function __set($name, $value)
    {}
    
    /**
     * Gets a LDAP attribute.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @return array 
     * @throws Zend_Ldap_Exception
     */
    public function __get($name)
    {}
    
    /**
     * Deletes (empties) a LDAP attribute.
     * 
     * This method deletes the attribute contents without removing the attribute.
     * If the node is updated on the LDAP server the approrpiate attribute on the LDAP 
     * server gets *deleted*.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @return null
     * @throws Zend_Ldap_Exception
     */
    public function __unset($name)
    {}
    
    /**
     * Checks whether a given attribute exists.
     *
     * Empty attributes will be treated as non-existent. 
     * 
     * @param  string $name
     * @return boolean
     */
    public function __isset($name)
    {}
    
    /**
     * Sets a LDAP attribute.
     * Implements ArrayAccess.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @param  mixed $value
     * @return null
     * @throws Zend_Ldap_Exception
     */
    public function offsetSet($name, $value)
    {}
    
    /**
     * Gets a LDAP attribute.
     * Implements ArrayAccess.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @return array 
     * @throws Zend_Ldap_Exception
     */
    public function offsetGet($name)
    {}
    
    /**
     * Deletes (empties) a LDAP attribute.
     * Implements ArrayAccess.
     * 
     * This method deletes the attribute contents without removing the attribute.
     * If the node is updated on the LDAP server the approrpiate attribute on the LDAP 
     * server gets *deleted*.
     * 
     * This is an offline method.
     *
     * @param  string $name
     * @return null
     * @throws Zend_Ldap_Exception
     */
    public function offsetUnset($name)
    {}
    
    /**
     * Checks whether a given attribute exists.
     * Implements ArrayAccess.
     *
     * Empty attributes will be treated as non-existent. 
     * 
     * @param  string $name
     * @return boolean
     */
    public function offsetExists($name)
    {}
    
    /**
     * Check if node exists on LDAP.
     *
     * This is an online method.
     * 
     * @return boolean 
     * @throws Zend_Ldap_Exception
     */ 
    public function exists() 
    {} 
    
    /**
     * Reload node attributes from LDAP.
     *
     * This is an online method.
     * 
     * @return Zend_Ldap_Node *Provides a fluid interface* 
     * @throws Zend_Ldap_Exception
     */ 
    public function reload() 
    {}
    
    /**
     * Search current subtree with given options.
     * 
     * This is an online method.
     *
     * @param string $filter
     * @param integer $scope
     * @param array $attributes
     * @param string $sort
     * @return Zend_Ldap_QueryResult 
     * @throws Zend_Ldap_Exception
     */ 
    public function searchSubtree($filter, $scope=Zend_Ldap_Ext::SEARCH_SCOPE_SUB, 
        array $attributes=array(), $sort=null)
    {}
    
    /**
     * Count items in current subtree found by given filter.
     *
     * This is an online method.
     * 
     * @param string $filter
     * @param integer $scope
     * @return integer 
     * @throws Zend_Ldap_Exception
     */ 
    public function countSubtree($filter, $scope=Zend_Ldap_Ext::SEARCH_SCOPE_SUB)
    {}
    
    /**
     * Count children of current node.
     *
     * This is an online method.
     * 
     * @return integer 
     * @throws Zend_Ldap_Exception
     */ 
    public function countChildren()
    {}
    
    /**
     * Gets children of current node.
     * 
     * This is an online method.
     *
     * @param  string $filter
     * @param  array $attributes
     * @param  string $sort
     * @return Zend_Ldap_QueryResult 
     * @throws Zend_Ldap_Exception
     */ 
    public function searchChildren($filter, array $attributes=array(), $sort=null)
    {}
    
    /**
     * Returns the children for the current node.
     * 
     * This is an online method.
     * 
     * @return Zend_Ldap_Node_Children 
     * @throws Zend_Ldap_Exception
     */ 
    public function getChildren()
    {}
    
    /**
     * Returns the parent of the current node.
     *
     * @return Zend_Ldap_Node
     * @throws Zend_Ldap_Exception
     */
    public function getParent()
    {}
    
    /**
     * Checks if current node has children.
     * Returns whether the current element has children.
     * 
     * This is an online method.
     *
     * @return boolean 
     * @throws Zend_Ldap_Exception
     */
    public function hasChildren()
    {}
    
    /**
     * Returns an Iterator for the attributes.
     *
     * @return Zend_Ldap_Node_AttributeIterator
     */
    public function getIterator()
    {}
}

/**
 * Zend_Ldap_Node_Children provides a collecion of child nodes..
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Node_Children implements Iterator, RecursiveIterator, Countable 
{
    /**
     * The node to which this collection belongs to.
     *
     * @var Zend_Ldap_Node
     */
    private $_parent;
    /**
     * The query result.
     *
     * @var Zend_Ldap_QueryResult
     */
    private $_queryResult;
    /**
     * Iteration object cache.
     *
     * @var array of Zend_Ldap_Node
     */
    private $_cache;
    
    /**
     * Creates a new Zend_Ldap_Node_Children collection.
     *
     * @param Zend_Ldap_Node $parentNode
     * @param Zend_Ldap_QueryResult $queryResult
     */
    public function __construct(Zend_Ldap_Node $parentNode, Zend_Ldap_QueryResult $queryResult)
    {}
    
    /**
     * Returns the sub iterator for the current child node.
     * Implements RecursiveIterator
     *
     * @return Zend_Ldap_Node_Children 
     */ 
    public function getChildren()
    {}
    
    /**
     * Checks if current node has children.
     * Returns whether the current element has children.
     * Implements RecursiveIterator
     *
     * @return boolean 
     * @throws Zend_Ldap_Exception
     */
    public function hasChildren()
    {}
    
    /**
     * Returns the number of children in node.
     * Implements Countable
     *
     * @return int
     * @throws Zend_Ldap_Exception
     */
    public function count()
    {}
    
    /**
     * Return the current child node.
     * Implements Iterator and RecursiveIterator
     *
     * @return Zend_Ldap_Node
     */
    public function current()
    {}
    
    /**
     * Return the child key (DN).
     * Implements Iterator and RecursiveIterator
     *
     * @return string
     */
    public function key()
    {}
    
    /**
     * Move forward to next child node.
     * Implements Iterator and RecursiveIterator
     */
    public function next()
    {}
    
    /**
     * Rewind the Iterator to the first child node.
     * Implements Iterator and RecursiveIterator
     * 
     * @throws Zend_Ldap_Exception
     */
    public function rewind()
    {}
    
    /**
     * Check if there is a current child node
     * after calls to rewind() or next().
     * Implements Iterator and RecursiveIterator
     *
     * @return bool
     */
    public function valid()
    {}
    
    /**
     * Copies all child nodes into an array.
     *
     * @return array
     */
    public function toArray()
    {}
}

/**
 * Zend_Ldap_Node_AttributeIterator provides an iterator to the attribute collection.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Node_AttributeIterator implements Iterator 
{
    /**
     * The underlying node.
     *
     * @var Zend_Ldap_Node
     */
    private $_node;
    
    /**
     * The current iteration index.
     *
     * @var integer
     */
    private $_index;
    
    /**
     * All attribute keys.
     *
     * @var array
     */
    private $_keys;
    
    public function __construct(Zend_Ldap_Node $node)
    {}
    
    /**
     * Return the current attribute.
     * Implements Iterator
     *
     * @return array
     */
    public function current()
    {}
    
    /**
     * Return the attribute name.
     * Implements Iterator
     *
     * @return string
     */
    public function key()
    {}
    
    /**
     * Move forward to next attribute.
     * Implements Iterator
     */
    public function next()
    {}
    
    /**
     * Rewind the Iterator to the first attribute.
     * Implements Iterator
     */
    public function rewind()
    {}
    
    /**
     * Check if there is a current attribute
     * after calls to rewind() or next().
     * Implements Iterator
     *
     * @return bool
     */
    public function valid()
    {}
}

Page Operations

Browse Space

Zend_Ldap_Ext Proposal - Stefan Gehrig

Labels