Docs For Class Zend_Ldap_Collection_Iterator

Description

Implements interfaces:

Iterator (internal interface)
Countable (internal interface)

Zend_Ldap_Collection_Iterator_Default is the default collection iterator implementation using ext/ldap

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

Located in /Ldap/Collection/Iterator/Default.php (line 31)

Class Constant Summary

ATTRIBUTE_NATIVE = 3

ATTRIBUTE_TO_LOWER = 1

ATTRIBUTE_TO_UPPER = 2

Variable Summary

integer|callback $_attributeNameTreatment

resource $_current

integer $_itemCount

Zend_Ldap $_ldap

resource $_resultId

Method Summary

void __construct (Zend_Ldap $ldap, resource $resultId)

void __destruct ()

bool close ()

int count ()

array|null current ()

integer|callback getAttributeNameTreatment ()

Zend_Ldap getLdap ()

string|null key ()

void next ()

void rewind ()

Zend_Ldap_Collection_Iterator_Default setAttributeNameTreatment (integer|callback $attributeNameTreatment)

boolean valid ()

Variables

integer|callback $_attributeNameTreatment = self::ATTRIBUTE_TO_LOWER (line 70)

The method that will be applied to the attribute's names.

access: protected

resource $_current = null (line 56)

Current result entry identifier

access: protected

integer $_itemCount = -1 (line 63)

Number of items in query result

access: protected

Zend_Ldap $_ldap = null (line 42)

LDAP Connection

access: protected

resource $_resultId = null (line 49)

Result identifier resource

access: protected

Methods

Constructor __construct (line 79)

Constructor.

access: public

void __construct (Zend_Ldap $ldap, resource $resultId)

Zend_Ldap $ldap
resource $resultId

Destructor __destruct (line 93)

access: public

void __destruct ()

close (line 103)

Closes the current result set

access: public

bool close ()

count (line 180)

Returns the number of items in current result Implements Countable

access: public

int count ()

Implementation of:

Countable::count

current (line 192)

Return the current result item Implements Iterator

throws: Zend_Ldap_Exception
access: public

array|null current ()

Implementation of:

Iterator::current

getAttributeNameTreatment (line 169)

Returns the currently set attribute name treatment

access: public

integer|callback getAttributeNameTreatment ()

getLdap (line 119)

Gets the current LDAP connection.

access: public

Zend_Ldap getLdap ()

key (line 237)

Return the result item key Implements Iterator

access: public

string|null key ()

Implementation of:

Iterator::key

next (line 261)

Move forward to next result item Implements Iterator

throws: Zend_Ldap_Exception
access: public

void next ()

Implementation of:

Iterator::next

rewind (line 285)

Rewind the Iterator to the first result item Implements Iterator

throws: Zend_Ldap_Exception
access: public

void rewind ()

Implementation of:

Iterator::rewind

setAttributeNameTreatment (line 137)

Sets the attribute name treatment.

Can either be one of the following constants

Zend_Ldap_Collection_Iterator_Default::ATTRIBUTE_TO_LOWER
Zend_Ldap_Collection_Iterator_Default::ATTRIBUTE_TO_UPPER
Zend_Ldap_Collection_Iterator_Default::ATTRIBUTE_NATIVE

or a valid callback accepting the attribute's name as it's only argument and returning the new attribute's name.

return: Provides a fluent interface
access: public

Zend_Ldap_Collection_Iterator_Default setAttributeNameTreatment (integer|callback $attributeNameTreatment)

integer|callback $attributeNameTreatment

valid (line 305)

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

access: public

boolean valid ()

Implementation of:

Iterator::valid

Class Constants

ATTRIBUTE_NATIVE = 3 (line 35)

ATTRIBUTE_TO_LOWER = 1 (line 33)

ATTRIBUTE_TO_UPPER = 2 (line 34)