Inheritance diagram for PHPExcel_WorksheetIterator:

Collaboration diagram for PHPExcel_WorksheetIterator:

Public Member Functions
	__construct (PHPExcel $subject=null)
	Create a new worksheet iterator. More...

	__destruct ()
	Destructor. More...

	rewind ()
	Rewind iterator. More...

	current ()
	Current PHPExcel_Worksheet. More...

	key ()
	Current key. More...

	next ()
	Next value. More...

	valid ()
	More PHPExcel_Worksheet instances available? More...

Private Attributes
	$_subject

	$_position = 0

Detailed Description

Definition at line 38 of file WorksheetIterator.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_WorksheetIterator::__construct ( PHPExcel $subject = null )

Create a new worksheet iterator.

Parameters

PHPExcel $subject

Definition at line 59 of file WorksheetIterator.php.

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

◆ __destruct()

PHPExcel_WorksheetIterator::__destruct ( )

Destructor.

Definition at line 68 of file WorksheetIterator.php.

    {
        unset($this->_subject);
    }

Member Function Documentation

◆ current()

PHPExcel_WorksheetIterator::current ( )

Current PHPExcel_Worksheet.

Returns: PHPExcel_Worksheet

Definition at line 86 of file WorksheetIterator.php.

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

◆ key()

PHPExcel_WorksheetIterator::key ( )

Current key.

Returns: int

Definition at line 96 of file WorksheetIterator.php.

    {
        return $this->_position;
    }

References $_position.

◆ next()

PHPExcel_WorksheetIterator::next ( )

Next value.

Definition at line 104 of file WorksheetIterator.php.

    {
        ++$this->_position;
    }

References $_position.

◆ rewind()

PHPExcel_WorksheetIterator::rewind ( )

Rewind iterator.

Definition at line 76 of file WorksheetIterator.php.

    {
        $this->_position = 0;
    }

◆ valid()

PHPExcel_WorksheetIterator::valid ( )

More PHPExcel_Worksheet instances available?

Returns: boolean

Definition at line 114 of file WorksheetIterator.php.

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

Field Documentation

◆ $_position

PHPExcel_WorksheetIterator::$_position = 0

private

Definition at line 52 of file WorksheetIterator.php.

Referenced by key(), and next().

◆ $_subject

PHPExcel_WorksheetIterator::$_subject