Zend_Ldap_Collection_Iterator_Default Class Reference

Public Member Functions
	__construct (Zend_Ldap $ldap, $resultId)
	Constructor.
	__destruct ()
	close ()
	Closes the current result set.
	getLdap ()
	Gets the current LDAP connection.
	setAttributeNameTreatment ($attributeNameTreatment)
	Sets the attribute name treatment.
	getAttributeNameTreatment ()
	Returns the currently set attribute name treatment.
	count ()
	Returns the number of items in current result Implements Countable.
	current ()
	Return the current result item Implements Iterator.
	key ()
	Return the 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.

Public Attributes
const	ATTRIBUTE_TO_LOWER = 1
const	ATTRIBUTE_TO_UPPER = 2
const	ATTRIBUTE_NATIVE = 3

Protected Attributes
	$_ldap = null
	$_resultId = null
	$_current = null
	$_itemCount = -1
	$_attributeNameTreatment = self::ATTRIBUTE_TO_LOWER

Constructor & Destructor Documentation

__construct	(	Zend_Ldap	$ldap,
			$resultId
	)

Constructor.

Parameters

Zend_Ldap	$ldap
resource	$resultId

Returns

void

See Also

Zend_Ldap_Exception

__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

current

(

)

Return the current result item Implements Iterator.

Returns

array|null

Exceptions

Zend_Ldap_Exception

getAttributeNameTreatment

(

)

Returns the currently set attribute name treatment.

Returns

integer|callback

getLdap

(

)

Gets the current LDAP connection.

Returns

Zend_Ldap

key

(

)

Return the result item key Implements Iterator.

Returns

string|null

See Also

Zend_Ldap_Exception

next

(

)

Move forward to next result item Implements Iterator.

Exceptions

Zend_Ldap_Exception

See Also

Zend_Ldap_Exception

rewind

(

)

Rewind the Iterator to the first result item Implements Iterator.

Exceptions

Zend_Ldap_Exception

See Also

Zend_Ldap_Exception

setAttributeNameTreatment

(

$attributeNameTreatment

)

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.

Parameters

integer | callback

$attributeNameTreatment

Returns

Zend_Ldap_Collection_Iterator_Default Provides a fluent interface

valid

(

)

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

Returns

boolean

Member Data Documentation

$_attributeNameTreatment = self::ATTRIBUTE_TO_LOWER

protected

$_current = null

protected

$_itemCount = -1

protected

$_ldap = null

protected

$_resultId = null

protected

const ATTRIBUTE_NATIVE = 3

const ATTRIBUTE_TO_LOWER = 1

const ATTRIBUTE_TO_UPPER = 2