Zend_Ldap_Collection wraps a list of LDAP entries.

category Zend
package Zend_Ldap
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor.

__construct(\Zend_Ldap_Collection_Iterator_Default $iterator) 

Parameters

$iterator

\Zend_Ldap_Collection_Iterator_Default

__destruct()

__destruct() 

Closes the current result set

close() : boolean

Returns

boolean

Returns the number of items in current result Implements Countable

count() : integer

Returns

integer

Return the current result item Implements Iterator

current() : array | null

Exceptions

\Zend_Ldap_Exception

Returns

arraynull

Return the current result item DN

dn() : string | null

Returns

stringnull

Get first entry

getFirst() : array

Returns

array

Returns the underlying iterator

getInnerIterator() : \Zend_Ldap_Collection_Iterator_Default

Returns

\Zend_Ldap_Collection_Iterator_Default

Return the current result item key Implements Iterator

key() : integer | null

Returns

integernull

Move forward to next result item Implements Iterator

next() 

Exceptions

\Zend_Ldap_Exception

Rewind the Iterator to the first result item Implements Iterator

rewind() 

Exceptions

\Zend_Ldap_Exception

Get all entries as an array

toArray() : array

Returns

array

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

valid() : boolean

Returns

boolean

Creates the data structure for the given entry data

_createEntry(array $data) : array

Parameters

$data

array

Returns

array

 Properties

 

Container for item caching to speed up multiple iterations

$_cache : array

Default

array()
 

Current item number

$_current : integer

Default

-1
 

Iterator

$_iterator : \Zend_Ldap_Collection_Iterator_Default

Default

null