Doctrine_Collection_Iterator_Normal Class Reference

Inherits Doctrine_Collection_Iterator.

Public Member Functions
	current ()
	key ()
	next ()
	rewind ()
	valid ()

Protected Attributes
	$collection

Detailed Description

Definition at line 33 of file Normal.php.

Member Function Documentation

Doctrine_Collection_Iterator::current ( )

inherited

returns the current record

Returns

Doctrine_Record

Definition at line 101 of file Iterator.php.

    {
        return $this->collection->get($this->key);
    }

Doctrine_Collection_Iterator::key ( )

inherited

returns the current key

Returns

integer

Definition at line 91 of file Iterator.php.

    {
        return $this->key;
    }

Doctrine_Collection_Iterator::next ( )

inherited

advances the internal pointer

Returns

void

Definition at line 111 of file Iterator.php.

    {
        $this->index++;
        $i = $this->index;
        if (isset($this->keys[$i])) {
            $this->key   = $this->keys[$i];
        }
    }

Doctrine_Collection_Iterator::rewind ( )

inherited

rewinds the iterator

Returns

void

Definition at line 77 of file Iterator.php.

    {
        $this->index = 0;
        $i = $this->index;
        if (isset($this->keys[$i])) {
            $this->key   = $this->keys[$i];
        }
    }

Doctrine_Collection_Iterator_Normal::valid

(

)

Returns

boolean whether or not the iteration will continue

Definition at line 38 of file Normal.php.

    {
        return ($this->index < $this->count);
    }

Field Documentation

Doctrine_Collection Doctrine_Collection_Iterator::$collection

protectedinherited

constructor

Definition at line 39 of file Iterator.php.

---

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

• Doctrine-1.2.4/Doctrine/Collection/Iterator/Normal.php