Ldap/Collection/Iterator/Default.php

Show:

inherited

Classes
- \Zend_Ldap_Collection_Iterator_Default

Table of Contents

Zend Framework

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Ldap
Version: $Id$

\Zend_Ldap_Collection_Iterator_Default
jump to top

Package: Zend_Ldap

Zend_Ldap_Collection_Iterator_Default is the default collection iterator implementation using ext/ldap

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                ATTRIBUTE_TO_LOWER
                = 1

 
                ATTRIBUTE_TO_UPPER
                = 2

 
                ATTRIBUTE_NATIVE
                = 3

Properties

integer|callback $_attributeNameTreatment = self::ATTRIBUTE_TO_LOWER

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

Default valueself::ATTRIBUTE_TO_LOWERDetails

Type: integer | callback

resource $_current = null

Current result entry identifier

Default valuenullDetails

Type: resource

integer $_itemCount = -1

Number of items in query result

Default value-1Details

Type: integer

\Zend_Ldap $_ldap = null

LDAP Connection

Default valuenullDetails

Type: \Zend_Ldap

resource $_resultId = null

Result identifier resource

Default valuenullDetails

Type: resource

Methods

__construct(\Zend_Ldap $ldap, resource $resultId) : void

Constructor.

Parameters

Name	Type	Description
$ldap	\Zend_Ldap
$resultId	resource

__destruct() : void

close() : bool

Closes the current result set

Returns

Type	Description
bool

count() : int

Returns the number of items in current result Implements Countable

Returns

Type	Description
int

current() : array | null

Return the current result item Implements Iterator

Returns

Type	Description
array \| null

Throws

Exception	Description
\Zend_Ldap_Exception

getAttributeNameTreatment() : integer | callback

Returns the currently set attribute name treatment

Returns

Type	Description
integer \| callback

getLdap() : \Zend_Ldap

Gets the current LDAP connection.

Returns

Type	Description
\Zend_Ldap

key() : string | null

Return the result item key Implements Iterator

Returns

Type	Description
string \| null

next() : void

Move forward to next result item Implements Iterator

Throws

Exception	Description
\Zend_Ldap_Exception

rewind() : void

Rewind the Iterator to the first result item Implements Iterator

Throws

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.

Parameters

Name	Type	Description
$attributeNameTreatment	integer \| callback

Returns

Type	Description
\Zend_Ldap_Collection_Iterator_Default	Provides a fluent interface

valid() : boolean

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

Returns

Type	Description
boolean

Ldap/Collection/Iterator/Default.php

\Zend_Ldap_Collection_Iterator_Defaultjump to top

Constants

Properties

Methods

\Zend_Ldap_Collection_Iterator_Default
jump to top