PHPExcel_WorksheetIterator Class Reference

Inheritance diagram for PHPExcel_WorksheetIterator:

Collaboration diagram for PHPExcel_WorksheetIterator:

Public Member Functions
	__construct (PHPExcel $subject=null)
	Create a new worksheet iterator.
	__destruct ()
	Destructor.
	rewind ()
	Rewind iterator.
	current ()
	Current PHPExcel_Worksheet.
	key ()
	Current key.
	next ()
	Next value.
	valid ()
	More PHPExcel_Worksheet instances available?

Private Attributes
	$_subject
	$_position = 0

Detailed Description

Definition at line 53 of file WorksheetIterator.php.

Constructor & Destructor Documentation

PHPExcel_WorksheetIterator::__construct

(

PHPExcel

$subject = null

)

Create a new worksheet iterator.

Parameters

PHPExcel

$subject

Definition at line 74 of file WorksheetIterator.php.

                                                              {
                // Set subject
                $this->_subject = $subject;
        }

PHPExcel_WorksheetIterator::__destruct

(

)

Destructor.

Definition at line 82 of file WorksheetIterator.php.

                                     {
                unset($this->_subject);
        }

Member Function Documentation

PHPExcel_WorksheetIterator::current

(

)

Current PHPExcel_Worksheet.

Returns

PHPExcel_Worksheet

Definition at line 98 of file WorksheetIterator.php.

                              {
        return $this->_subject->getSheet($this->_position);
    }

PHPExcel_WorksheetIterator::key

(

)

Current key.

Returns

int

Definition at line 107 of file WorksheetIterator.php.

References $_position.

                          {
        return $this->_position;
    }

PHPExcel_WorksheetIterator::next

(

)

Next value.

Definition at line 114 of file WorksheetIterator.php.

References $_position.

                           {
        ++$this->_position;
    }

PHPExcel_WorksheetIterator::rewind

(

)

Rewind iterator.

Definition at line 89 of file WorksheetIterator.php.

                             {
        $this->_position = 0;
    }

PHPExcel_WorksheetIterator::valid

(

)

More PHPExcel_Worksheet instances available?

Returns

boolean

Definition at line 123 of file WorksheetIterator.php.

                            {
        return $this->_position < $this->_subject->getSheetCount();
    }

Field Documentation

PHPExcel_WorksheetIterator::$_position = 0

private

Definition at line 67 of file WorksheetIterator.php.

Referenced by key(), and next().

PHPExcel_WorksheetIterator::$_subject

private

Definition at line 60 of file WorksheetIterator.php.

---

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

• Services/Excel/classes/PHPExcel/WorksheetIterator.php