API Documentation

Ldap/Node/Collection.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Ldap  
subpackage
Node  
version
$Id: Collection.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Ldap_Node_Collection

Zend_Ldap_Node_Collection provides a collecion of nodes.

Extends from
\Zend_Ldap_Collection
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Ldap  
subpackage
Node  

Methods

methodpublic__construct( \Zend_Ldap_Collection_Iterator_Default $iterator ) : void

Constructor.

Inherited from: \Zend_Ldap_Collection::__construct()
Parameters
Name Type Description
$iterator \Zend_Ldap_Collection_Iterator_Default
methodpublic__destruct( ) : void
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

Closes the current result set

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

Returns the number of items in current result Implements Countable

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

Return the current result item Implements Iterator

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

Return the current result item DN

Inherited from: \Zend_Ldap_Collection::dn()
Returns
Type Description
stringnull
methodpublicgetFirst( ) : array

Get first entry

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

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

Move forward to next result item Implements Iterator

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

Rewind the Iterator to the first result item Implements Iterator

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

Get all entries as an array

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

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 DocBlox 0.13.3.