API Documentation

Zend/Ldap/Node/ChildrenIterator.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  
Subpackage
Node  
Version
$Id: ChildrenIterator.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Ldap_Node_ChildrenIterator

Package: Zend\Ldap\Node

Zend_Ldap_Node_ChildrenIterator provides an iterator to a collection of children nodes.

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

Properties

Propertyprivatearray  $_data= ''

An array of Zend_Ldap_Node objects

Details
Type
array

Methods

methodpublic__construct( array $data ) : void

Constructor.

Parameters
Name Type Description
$data array
methodpubliccount( ) : int

Returns the number of child nodes.

Implements Countable

Returns
Type Description
int
methodpubliccurrent( ) : \Zend_Ldap_Node

Return the current child.

Implements Iterator

Returns
Type Description
\Zend_Ldap_Node
methodpublicgetChildren( ) : \Zend_Ldap_Node_ChildrenIterator

Returns the children for the current node.

Returns
Type Description
\Zend_Ldap_Node_ChildrenIterator
methodpublichasChildren( ) : boolean

Checks if current node has children.

Returns whether the current element has children.

Returns
Type Description
boolean
methodpublickey( ) : string

Return the child'd RDN.

Implements Iterator

Returns
Type Description
string
methodpublicnext( ) : void

Move forward to next child.

Implements Iterator

methodpublicoffsetExists( string $rdn ) : boolean

Checks whether a given rdn exists.

Implements ArrayAccess.

Parameters
Name Type Description
$rdn string
Returns
Type Description
boolean
methodpublicoffsetGet( string $rdn ) : \Zend_Ldap_node

Returns a child with a given RDN.

Implements ArrayAccess.

Parameters
Name Type Description
$rdn string
Returns
Type Description
\Zend_Ldap_node
methodpublicoffsetSet( string $name, mixed $value ) : null

Does nothing.

Implements ArrayAccess.

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
null
methodpublicoffsetUnset( string $name ) : null

Does nothing.

Implements ArrayAccess.

Parameters
Name Type Description
$name string
Returns
Type Description
null
methodpublicrewind( ) : void

Rewind the Iterator to the first child.

Implements Iterator

methodpublictoArray( ) : array

Get all children as an array

Returns
Type Description
array
methodpublicvalid( ) : boolean

Check if there is a current child after calls to rewind() or next().

Implements Iterator

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.