Zend Framework  2.4
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Collection Class Reference

Zend wraps a list of LDAP entries. More...

Public Member Functions

 __construct (Collection\DefaultIterator $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()
 

Detailed Description

Zend wraps a list of LDAP entries.

Constructor & Destructor Documentation

__construct ( Collection\DefaultIterator  $iterator)

Constructor.

Parameters
Collection\DefaultIterator$iterator
__destruct ( )

Member Function Documentation

close ( )

Closes the current result set.

Returns
bool
count ( )

Returns the number of items in current result Implements Countable.

Returns
int
createEntry ( array  $data)
protected

Creates the data structure for the given entry data.

Parameters
array$data
Returns
array
current ( )

Return the current result item Implements Iterator.

Returns
array|null
Exceptions
Exception\LdapException
dn ( )

Return the current result item DN.

Returns
string|null
getFirst ( )

Get first entry.

Returns
array
getInnerIterator ( )

Returns the underlying iterator.

Returns
Collection
key ( )

Return the current result item key Implements Iterator.

Returns
int|null
next ( )

Move forward to next result item Implements Iterator.

Exceptions
Exception\LdapException
rewind ( )

Rewind the Iterator to the first result item Implements Iterator.

Exceptions
Exception\LdapException
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
bool

Member Data Documentation

$cache = array()
protected
$current = -1
protected
$iterator = null
protected