API Documentation

Zend/Ldap/Collection/Iterator/Default.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Ldap  
Version
$Id: Default.php 24613 2012-01-21 14:44:26Z sgehrig $  

\Zend_Ldap_Collection_Iterator_Default

Package: Zend\Ldap

Zend_Ldap_Collection_Iterator_Default is the default collection iterator implementation using ext/ldap

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

Constants

Constant  ATTRIBUTE_TO_LOWER = 1
Constant  ATTRIBUTE_TO_UPPER = 2
Constant  ATTRIBUTE_NATIVE = 3

Properties

Propertyprotectedinteger|callback  $_attributeNameTreatment= 'self::ATTRIBUTE_TO_LOWER'

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

Default valueself::ATTRIBUTE_TO_LOWERDetails
Type
integercallback
Propertyprotectedresource  $_current= 'null'

Current result entry identifier

Default valuenullDetails
Type
resource
Propertyprotectedinteger  $_itemCount= '-1'

Number of items in query result

Default value-1Details
Type
integer
Propertyprotected\Zend_Ldap  $_ldap= 'null'

LDAP Connection

Default valuenullDetails
Type
\Zend_Ldap
Propertyprotectedresource  $_resultId= 'null'

Result identifier resource

Default valuenullDetails
Type
resource

Methods

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

Constructor.

Parameters
Name Type Description
$ldap \Zend_Ldap
$resultId resource
methodpublic__destruct( ) : void

methodpublicclose( ) : bool

Closes the current result set

Returns
Type Description
bool
methodpubliccount( ) : int

Returns the number of items in current result Implements Countable

Returns
Type Description
int
methodpubliccurrent( ) : array|null

Return the current result item Implements Iterator

Returns
Type Description
array|null
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicgetAttributeNameTreatment( ) : integer|callback

Returns the currently set attribute name treatment

Returns
Type Description
integer|callback
methodpublicgetLdap( ) : \Zend_Ldap

Gets the current LDAP connection.

Returns
Type Description
\Zend_Ldap
methodpublickey( ) : string|null

Return the result item key Implements Iterator

Returns
Type Description
string|null
methodpublicnext( ) : void

Move forward to next result item Implements Iterator

Throws
Exception Description
\Zend_Ldap_Exception
methodpublicrewind( ) : void

Rewind the Iterator to the first result item Implements Iterator

Throws
Exception Description
\Zend_Ldap_Exception
methodpublicsetAttributeNameTreatment( 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
methodpublicvalid( ) : boolean

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

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.