Ldap/Collection/Iterator/Default.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Ldap
- Version
- $Id: Default.php 24612 2012-01-21 14:42:30Z sgehrig $
\Zend_Ldap_Collection_Iterator_Default
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


integer|callback $_attributeNameTreatment = self::ATTRIBUTE_TO_LOWER
self::ATTRIBUTE_TO_LOWER
Details- Type
- integer | callback
Methods


__construct(\Zend_Ldap $ldap, resource $resultId) : void
Constructor.
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap | |
$resultId | resource |


count() : int
Returns the number of items in current result Implements Countable
Type | Description |
---|---|
int |


current() : array | null
Return the current result item Implements Iterator
Type | Description |
---|---|
array | null |
Exception | Description |
---|---|
\Zend_Ldap_Exception |


getAttributeNameTreatment() : integer | callback
Returns the currently set attribute name treatment
Type | Description |
---|---|
integer | callback |


key() : string | null
Return the result item key Implements Iterator
Type | Description |
---|---|
string | null |


next() : void
Move forward to next result item Implements Iterator
Exception | Description |
---|---|
\Zend_Ldap_Exception |


rewind() : void
Rewind the Iterator to the first result item Implements Iterator
Exception | Description |
---|---|
\Zend_Ldap_Exception |


setAttributeNameTreatment(integer | callback $attributeNameTreatment) : \Zend_Ldap_Collection_Iterator_Default
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.
Name | Type | Description |
---|---|---|
$attributeNameTreatment | integer | callback |
Type | Description |
---|---|
\Zend_Ldap_Collection_Iterator_Default | Provides a fluent interface |