Ldap/Node/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 [email protected] 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  
Subpackage
Node  
Version
$Id: Collection.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Ldap_Node_Collection

Package: Zend\Ldap\Node

Zend_Ldap_Node_Collection provides a collecion of nodes.

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

Properties

Propertyprotectedarray $_cache = array()
inherited

Container for item caching to speed up multiple iterations

Inherited from: \Zend_Ldap_Collection::$$_cache
Default valuearray()Details
Type
array
Inherited_from
\Zend_Ldap_Collection::$$_cache  
Propertyprotectedinteger $_current = -1
inherited

Current item number

Inherited from: \Zend_Ldap_Collection::$$_current
Default value-1Details
Type
integer
Inherited_from
\Zend_Ldap_Collection::$$_current  
Propertyprotected\Zend_Ldap_Collection_Iterator_Default $_iterator = null
inherited

Iterator

Inherited from: \Zend_Ldap_Collection::$$_iterator
Default valuenullDetails
Type
\Zend_Ldap_Collection_Iterator_Default
Inherited_from
\Zend_Ldap_Collection::$$_iterator  

Methods

methodpublic__construct(\Zend_Ldap_Collection_Iterator_Default $iterator) : void
inherited

Constructor.

Inherited from: \Zend_Ldap_Collection::__construct()
Parameters
Name Type Description
$iterator \Zend_Ldap_Collection_Iterator_Default
methodpublic__destruct() : void
inherited

Inherited from: \Zend_Ldap_Collection::__destruct()
methodprotected_createEntry(array $data) : \Zend_Ldap_Node

Creates the data structure for the given entry data

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

Closes the current result set

Inherited from: \Zend_Ldap_Collection::close()
Returns
Type Description
boolean
methodpubliccount() : int
inherited

Returns the number of items in current result Implements Countable

Inherited from: \Zend_Ldap_Collection::count()
Returns
Type Description
int
methodpubliccurrent() : array | null
inherited

Return the current result item Implements Iterator

Inherited from: \Zend_Ldap_Collection::current()
Returns
Type Description
array | null
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicdn() : string | null
inherited

Return the current result item DN

Inherited from: \Zend_Ldap_Collection::dn()
Returns
Type Description
string | null
methodpublicgetFirst() : array
inherited

Get first entry

Inherited from: \Zend_Ldap_Collection::getFirst()
Returns
Type Description
array
methodpublicgetInnerIterator() : \Zend_Ldap_Collection_Iterator_Default
inherited

Returns the underlying iterator

Inherited from: \Zend_Ldap_Collection::getInnerIterator()
Returns
Type Description
\Zend_Ldap_Collection_Iterator_Default
methodpublickey() : string

Return the child key (DN).

Implements Iterator and RecursiveIterator

Returns
Type Description
string
methodpublicnext() : void
inherited

Move forward to next result item Implements Iterator

Inherited from: \Zend_Ldap_Collection::next()
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicrewind() : void
inherited

Rewind the Iterator to the first result item Implements Iterator

Inherited from: \Zend_Ldap_Collection::rewind()
Throws
Exception Description
\Zend_Ldap_Exception
methodpublictoArray() : array
inherited

Get all entries as an array

Inherited from: \Zend_Ldap_Collection::toArray()
Returns
Type Description
array
methodpublicvalid() : boolean
inherited

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

Inherited from: \Zend_Ldap_Collection::valid()
Returns
Type Description
boolean
Documentation was generated by phpDocumentor 2.0.0a8.