Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Ldap_Collection Class Reference

Public Member Functions

 __construct (Zend_Ldap_Collection_Iterator_Default $iterator)
 Constructor.
 
 __destruct ()
 
 close ()
 Closes the current result set.
 
 toArray ()
 Get all entries as an array.
 
 getFirst ()
 Get first entry.
 
 getInnerIterator ()
 Returns the underlying iterator.
 
 count ()
 Returns the number of items in current result Implements Countable.
 
 current ()
 Return the current result item Implements Iterator.
 
 dn ()
 Return the current result item DN.
 
 key ()
 Return the current result item key Implements Iterator.
 
 next ()
 Move forward to next result item Implements Iterator.
 
 rewind ()
 Rewind the Iterator to the first result item Implements Iterator.
 
 valid ()
 Check if there is a current result item after calls to rewind() or next() Implements Iterator.
 

Protected Member Functions

 _createEntry (array $data)
 Creates the data structure for the given entry data.
 

Protected Attributes

 $_iterator = null
 
 $_current = -1
 
 $_cache = array()
 

Constructor & Destructor Documentation

__construct ( Zend_Ldap_Collection_Iterator_Default  $iterator)

Constructor.

Parameters
Zend_Ldap_Collection_Iterator_Default$iterator
__destruct ( )

Member Function Documentation

_createEntry ( array  $data)
protected

Creates the data structure for the given entry data.

Parameters
array$data
Returns
array
close ( )

Closes the current result set.

Returns
boolean
count ( )

Returns the number of items in current result Implements Countable.

Returns
int
current ( )

Return the current result item Implements Iterator.

Returns
array|null
Exceptions
Zend_Ldap_Exception
dn ( )

Return the current result item DN.

Returns
string|null
getFirst ( )

Get first entry.

Returns
array
getInnerIterator ( )

Returns the underlying iterator.

Returns
Zend_Ldap_Collection_Iterator_Default
key ( )

Return the current result item key Implements Iterator.

Returns
int|null
next ( )

Move forward to next result item Implements Iterator.

Exceptions
Zend_Ldap_Exception
rewind ( )

Rewind the Iterator to the first result item Implements Iterator.

Exceptions
Zend_Ldap_Exception
toArray ( )

Get all entries as an array.

Returns
array
valid ( )

Check if there is a current result item after calls to rewind() or next() Implements Iterator.

Returns
boolean

Member Data Documentation

$_cache = array()
protected
$_current = -1
protected
$_iterator = null
protected