Class Swift_Iterator_Array

Description

Implements interfaces:

Swift Array Iterator Interface Iterates over a standard PHP array.

Located in /Swift/Iterator/Array.php (line 20)


	
			
Variable Summary
array $keys
int $pos
array $values
Method Summary
Swift_Iterator_Array __construct (array $input)
array getArray ()
int getPosition ()
mixed. getValue ()
boolean hasNext ()
boolean next ()
boolean seekTo (int $pos)
Variables
array $keys (line 26)

All keys in this array.

  • access: protected
int $pos = -1 (line 36)

The current array position.

  • access: protected
array $values (line 31)

All values in this array.

  • access: protected
Methods
Constructor __construct (line 42)

Ctor.

  • access: public
Swift_Iterator_Array __construct (array $input)
  • array $input: The array to iterate over.
getArray (line 52)

Returns the original array.

  • access: public
array getArray ()
getPosition (line 107)

Gets the current numeric position within the array.

  • access: public
int getPosition ()

Implementation of:
Swift_Iterator::getPosition()
Get the current list position.
getValue (line 97)

Returns the value at the current position, or NULL otherwise.

  • access: public
mixed. getValue ()

Implementation of:
Swift_Iterator::getValue()
Get the value of the list at the current position.
hasNext (line 60)

Returns true if there is a value after the current one.

  • access: public
boolean hasNext ()

Implementation of:
Swift_Iterator::hasNext()
Check if there is a value in the list after the current one.
next (line 68)

Moves to the next array element if possible.

  • access: public
boolean next ()

Implementation of:
Swift_Iterator::next()
Move to the next position in the list if possible.
seekTo (line 83)

Goes directly to the given element in the array if possible.

  • access: public
boolean seekTo (int $pos)
  • int $pos: Numeric position

Implementation of:
Swift_Iterator::seekTo()
Seek to the given numeric index in the list of possible.

Documentation generated on Wed, 26 Mar 2008 20:33:02 +1100 by phpDocumentor 1.3.1