API Documentation

Zend/Ldap/Collection.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: Collection.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Ldap_Collection

Package: Zend\Ldap

Zend_Ldap_Collection wraps a list of LDAP entries.

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

Properties

Propertyprotectedarray  $_cache= 'array()'

Container for item caching to speed up multiple iterations

Default valuearray()Details
Type
array
Propertyprotectedinteger  $_current= '-1'

Current item number

Default value-1Details
Type
integer
Propertyprotected\Zend_Ldap_Collection_Iterator_Default  $_iterator= 'null'

Iterator

Default valuenullDetails
Type
\Zend_Ldap_Collection_Iterator_Default

Methods

methodpublic__construct( \Zend_Ldap_Collection_Iterator_Default $iterator ) : void

Constructor.

Parameters
Name Type Description
$iterator \Zend_Ldap_Collection_Iterator_Default
methodpublic__destruct( ) : void

methodprotected_createEntry( array $data ) : array

Creates the data structure for the given entry data

Parameters
Name Type Description
$data array
Returns
Type Description
array
methodpublicclose( ) : boolean

Closes the current result set

Returns
Type Description
boolean
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
methodpublicdn( ) : string|null

Return the current result item DN

Returns
Type Description
string|null
methodpublicgetFirst( ) : array

Get first entry

Returns
Type Description
array
methodpublicgetInnerIterator( ) : \Zend_Ldap_Collection_Iterator_Default

Returns the underlying iterator

Returns
Type Description
\Zend_Ldap_Collection_Iterator_Default
methodpublickey( ) : int|null

Return the current result item key Implements Iterator

Returns
Type Description
int|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
methodpublictoArray( ) : array

Get all entries as an array

Returns
Type Description
array
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.