API Documentation

Ldap/Node/ChildrenIterator.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Ldap
subpackage
Node
version
$Id: ChildrenIterator.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Ldap_Node_ChildrenIterator

Description

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.

Zend_Ldap_Node_ChildrenIterator
jump to top

Implements
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Ldap
subpackage
Node
Properties
$_data
Methods
__construct
count
current
key
next
rewind
valid
hasChildren
getChildren
offsetGet
offsetExists
offsetUnset
offsetSet
toArray

Description

Zend_Ldap_Node_ChildrenIterator provides an iterator to a collection of children nodes.

Properties

$_data
jump to class

array $_data = ''

An array of Zend_Ldap_Node objects

Details

$_data
array
visibility
private
default
final
false
static
false

Methods

__construct
jump to class

__construct( array $data ) : void

Constructor.

Arguments
$data
array
Details
visibility
public
final
false
static
false

count
jump to class

count( ) : int

Returns the number of child nodes.

Implements Countable

Output
int
Details
visibility
public
final
false
static
false

current
jump to class

current( ) : Zend_Ldap_Node

Return the current child.

Implements Iterator

Output
Zend_Ldap_Node
Details
visibility
public
final
false
static
false

getChildren
jump to class

getChildren( ) : Zend_Ldap_Node_ChildrenIterator

Returns the children for the current node.

Output
Zend_Ldap_Node_ChildrenIterator
Details
visibility
public
final
false
static
false

hasChildren
jump to class

hasChildren( ) : boolean

Checks if current node has children.

Returns whether the current element has children.

Output
boolean
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : string

Return the child'd RDN.

Implements Iterator

Output
string
Details
visibility
public
final
false
static
false

next
jump to class

next( ) :

Move forward to next child.

Implements Iterator

Details
visibility
public
final
false
static
false

offsetExists
jump to class

offsetExists( string $rdn ) : boolean

Checks whether a given rdn exists.

Implements ArrayAccess.

Arguments
$rdn
string
Output
boolean
Details
visibility
public
final
false
static
false

offsetGet
jump to class

offsetGet( string $rdn ) : Zend_Ldap_node

Returns a child with a given RDN.

Implements ArrayAccess.

Arguments
$rdn
string
Output
Zend_Ldap_node
Details
visibility
public
final
false
static
false

offsetSet
jump to class

offsetSet( string $name, mixed $value ) : null

Does nothing.

Implements ArrayAccess.

Arguments
$name
string
$value
mixed
Output
null
Details
visibility
public
final
false
static
false

offsetUnset
jump to class

offsetUnset( string $name ) : null

Does nothing.

Implements ArrayAccess.

Arguments
$name
string
Output
null
Details
visibility
public
final
false
static
false

rewind
jump to class

rewind( ) :

Rewind the Iterator to the first child.

Implements Iterator

Details
visibility
public
final
false
static
false

toArray
jump to class

toArray( ) : array

Get all children as an array

Output
array
Details
visibility
public
final
false
static
false

valid
jump to class

valid( ) : boolean

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

Implements Iterator

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.