Class Zend_Ldap_Collection

Description

Implements interfaces:

  • Iterator (internal interface)
  • Countable (internal interface)

Zend_Ldap_Collection wraps a list of LDAP entries.

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Ldap/Collection.php (line 30)


	
			
Direct descendents
Class Description
 class Zend_Ldap_Node_Collection Zend_Ldap_Node_Collection provides a collecion of nodes.
Variable Summary
Method Summary
 Zend_Ldap_Collection __construct (Zend_Ldap_Collection_Iterator_Default $iterator)
 void __destruct ()
 boolean close ()
 int count ()
 array|null current ()
 string|null dn ()
 array getFirst ()
 int|null key ()
 void next ()
 void rewind ()
 array toArray ()
 boolean valid ()
 array _createEntry ( $data)
Variables
array $_cache = array() (line 51)

Container for item caching to speed up multiple iterations

  • access: protected
integer $_current = -1 (line 44)

Current item number

  • access: protected
Zend_Ldap_Collection_Iterator_Default $_iterator = null (line 37)

Iterator

  • access: protected
Methods
Constructor __construct (line 58)

Constructor.

  • access: public
Zend_Ldap_Collection __construct (Zend_Ldap_Collection_Iterator_Default $iterator)
Destructor __destruct (line 63)
  • access: public
void __destruct ()
close (line 73)

Closes the current result set

  • access: public
boolean close ()
count (line 123)

Returns the number of items in current result Implements Countable

  • access: public
int count ()

Implementation of:
Countable::count
current (line 135)

Return the current result item Implements Iterator

  • throws: Zend_Ldap_Exception
  • access: public
array|null current ()

Implementation of:
Iterator::current
dn (line 170)

Return the current result item DN

  • access: public
string|null dn ()
getFirst (line 97)

Get first entry

  • access: public
array getFirst ()
getInnerIterator (line 112)

Returns the underlying iterator

  • access: public
key (line 188)

Return the current result item key Implements Iterator

  • access: public
int|null key ()

Implementation of:
Iterator::key

Redefined in descendants as:
next (line 206)

Move forward to next result item Implements Iterator

  • throws: Zend_Ldap_Exception
  • access: public
void next ()

Implementation of:
Iterator::next
rewind (line 218)

Rewind the Iterator to the first result item Implements Iterator

  • throws: Zend_Ldap_Exception
  • access: public
void rewind ()

Implementation of:
Iterator::rewind
toArray (line 83)

Get all entries as an array

  • access: public
array toArray ()
valid (line 231)

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

  • access: public
boolean valid ()

Implementation of:
Iterator::valid
_createEntry (line 160)

Creates the data structure for the given entry data

  • access: protected
array _createEntry ( $data)
  • array $data

Redefined in descendants as:

Documentation generated on Mon, 21 Jun 2010 15:12:33 -0400 by phpDocumentor 1.4.3