zVectIterator Class Reference
[OOPS data structures.]

Inheritance diagram for zVectIterator:

[legend]

Collaboration diagram for zVectIterator:

[legend]

Public Member Functions
	zVectIterator ($vector)
	toFront ()
	Starts Iteration towards Front.
	toBack ()
	Starts Iteration towards Back.
	hasNext ()
	Checks wheather or not the current Node has a next element.
	hasPrevious ()
	Checks wheather or not the current Node has a Previous element.
	next ()
	Get the Next Item.
	previous ()
	Get the Previous Node.
	value ()
	Returns the data stored in the Current Node.
	remove ()
	Removes the Current Node and its Child nodes too.
	setValue ($val)
	setvalue to the current Node
	index ()
	Returns the Current Index.
	size ()
	Returns the Size (Length) of the target Iterable Vector.
	begin ()
	Checks wheather or not the current node is the begening node.
	end ()
	Checks wheather or not the Current Node is the Ending Node.
Data Fields
	$vector
	$direction = true
	$iterationIndex = -1

---

Detailed Description

Definition at line 116 of file zvect.php.

---

Member Function Documentation

zVectIterator::zVectIterator( unknown $vector ) 

Definition at line 142 of file zvect.php.

References $vector.

Show Source

                                 {
    $this->vector = $vector;
  }

Top 

zVectIterator::toFront( ) 

Starts Iteration towards Front.

Definition at line 149 of file zvect.php.

Show Source

                    {
    $this->direction=true;
    $this->iterationIndex=0;
  }

Top 

zVectIterator::toBack( ) 

Starts Iteration towards Back.

Definition at line 157 of file zvect.php.

Show Source

                   {
    $this->direction=false;
    $this->iterationIndex=0;
  }

Top 

zVectIterator::hasNext( ) 

Checks wheather or not the current Node has a next element.

Returns:

boolean

Definition at line 166 of file zvect.php.

Show Source

                    {
    $currentNode = $this->vector->at($this->iterationIndex++);
    return $currentNode->hasNext();
  }

Top 

zVectIterator::hasPrevious( ) 

Checks wheather or not the current Node has a Previous element.

Returns:

boolean

Definition at line 175 of file zvect.php.

Show Source

                        {
    $currentNode = $this->vector->at($this->iterationIndex--);
    return $currentNode->hasParent();
  }

Top 

zVectIterator::next( ) 

Get the Next Item.

Returns:

zItem

Definition at line 184 of file zvect.php.

Show Source

                 {
    $currentNode = $this->vector->at($this->iterationIndex);
    return $currentNode->getNext();
  }

Top 

zVectIterator::previous( ) 

Get the Previous Node.

Returns:

zItem

Definition at line 193 of file zvect.php.

Show Source

                     {
    $currentNode = $this->vector->at($this->iterationIndex);
    return $currentNode->getPrevious();
  }

Top 

zVectIterator::value( ) 

Returns the data stored in the Current Node.

Returns:

mixed

Definition at line 202 of file zvect.php.

Show Source

                  {
    return $this->vector->dataAt($this->iterationIndex);
  }

Top 

zVectIterator::remove( ) 

Removes the Current Node and its Child nodes too.

Definition at line 209 of file zvect.php.

Show Source

                   {
    $this->vector->remove($this->iterationIndex);
  }

Top 

zVectIterator::setValue( mixed $val ) 

setvalue to the current Node

Parameters:

$val

Definition at line 217 of file zvect.php.

References $val.

Show Source

                         {
    $currentNode = $this->vector->at($this->iterationIndex);
    return $currentNode->setData($val);
  }

Top 

zVectIterator::index( ) 

Returns the Current Index.

Returns:

Integer

Definition at line 226 of file zvect.php.

Show Source

                  {
    return $this->iterationIndex;
  }

Top 

zVectIterator::size( ) 

Returns the Size (Length) of the target Iterable Vector.

Returns:

Integer

Definition at line 234 of file zvect.php.

Show Source

                 {
    return $this->vector->length();
  }

Top 

zVectIterator::begin( ) 

Checks wheather or not the current node is the begening node.

Returns:

boolean

Definition at line 242 of file zvect.php.

Show Source

                  {
    $currentNode = $this->vector->at($this->iterationIndex);
    return !$currentNode->hasParent();
  }

Top 

zVectIterator::end( ) 

Checks wheather or not the Current Node is the Ending Node.

Definition at line 250 of file zvect.php.

Show Source

                {
    $currentNode = $this->vector->at($this->iterationIndex);
    return !$currentNode->hasNext();
  }

Top 

---

Field Documentation

zVectIterator::$vector

Definition at line 124 of file zvect.php.

Referenced by zVectIterator().

Top 

zVectIterator::$direction = true

Definition at line 132 of file zvect.php.

Top 

zVectIterator::$iterationIndex = -1

Definition at line 140 of file zvect.php.

Top 

---

The documentation for this class was generated from the following file:

• zvect.php