Ldap/Node/Collection.php

Show: PublicProtectedPrivateinherited
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  
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

>VPropertyprotectedarray $_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  
>VPropertyprotectedinteger $_current = -1
inherited
Current item number
Inherited from: \Zend_Ldap_Collection::$$_current
Default value-1Details
Type
integer
Inherited_from
\Zend_Ldap_Collection::$$_current  
>VPropertyprotected\Zend_Ldap_Collection_Iterator_Default $_iterator = null
inherited
Iterator
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
NameTypeDescription
$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
NameTypeDescription
$dataarray
Returns
TypeDescription
\Zend_Ldap_Node
methodpublicclose() : boolean
inherited

Closes the current result set

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

Returns the number of items in current result Implements Countable

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

Return the current result item Implements Iterator

Inherited from: \Zend_Ldap_Collection::current()
Returns
TypeDescription
array | null
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublicdn() : string | null
inherited

Return the current result item DN

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

Get first entry

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

Returns the underlying iterator

Inherited from: \Zend_Ldap_Collection::getInnerIterator()
methodpublickey() : string

Return the child key (DN).

Implements Iterator and RecursiveIterator

Returns
TypeDescription
string
methodpublicnext() : void
inherited

Move forward to next result item Implements Iterator

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

Rewind the Iterator to the first result item Implements Iterator

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

Get all entries as an array

Inherited from: \Zend_Ldap_Collection::toArray()
Returns
TypeDescription
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
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.