PHPExcel_Worksheet_CellIterator Class Reference

Inheritance diagram for PHPExcel_Worksheet_CellIterator:

Collaboration diagram for PHPExcel_Worksheet_CellIterator:

Public Member Functions
	__destruct ()
	Destructor. More...
	getIterateOnlyExistingCells ()
	Get loop only existing cells. More...
	setIterateOnlyExistingCells ($value=true)
	Set the iterator to loop only existing cells. More...

Protected Member Functions
	adjustForExistingOnlyRange ()
	Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary. More...

Protected Attributes
	$_subject
	$_position = null
	$_onlyExistingCells = false

Detailed Description

Definition at line 38 of file CellIterator.php.

Constructor & Destructor Documentation

__destruct()

PHPExcel_Worksheet_CellIterator::__destruct

(

)

Destructor.

Definition at line 64 of file CellIterator.php.

                                     {
                unset($this->_subject);
        }

Member Function Documentation

adjustForExistingOnlyRange()

PHPExcel_Worksheet_CellIterator::adjustForExistingOnlyRange ( )

abstractprotected

Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.

Exceptions

PHPExcel_Exception

Referenced by getIterateOnlyExistingCells(), and setIterateOnlyExistingCells().

Here is the caller graph for this function:

getIterateOnlyExistingCells()

PHPExcel_Worksheet_CellIterator::getIterateOnlyExistingCells

(

)

Get loop only existing cells.

Returns

boolean

Definition at line 73 of file CellIterator.php.

References $_onlyExistingCells, and adjustForExistingOnlyRange().

                                                  {
        return $this->_onlyExistingCells;
    }

Here is the call graph for this function:

setIterateOnlyExistingCells()

PHPExcel_Worksheet_CellIterator::setIterateOnlyExistingCells

(

$value = true

)

Set the iterator to loop only existing cells.

Parameters

boolean

$value

Exceptions

PHPExcel_Exception

Definition at line 90 of file CellIterator.php.

References adjustForExistingOnlyRange().

                                                               {
        $this->_onlyExistingCells = (boolean) $value;

        $this->adjustForExistingOnlyRange();
    }

Here is the call graph for this function:

Field Documentation

$_onlyExistingCells

PHPExcel_Worksheet_CellIterator::$_onlyExistingCells = false

protected

Definition at line 59 of file CellIterator.php.

Referenced by getIterateOnlyExistingCells().

$_position

PHPExcel_Worksheet_CellIterator::$_position = null

protected

Definition at line 52 of file CellIterator.php.

Referenced by PHPExcel_Worksheet_ColumnCellIterator\key(), PHPExcel_Worksheet_ColumnCellIterator\next(), PHPExcel_Worksheet_RowCellIterator\next(), PHPExcel_Worksheet_ColumnCellIterator\prev(), and PHPExcel_Worksheet_RowCellIterator\prev().

$_subject

PHPExcel_Worksheet_CellIterator::$_subject

protected

Definition at line 45 of file CellIterator.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/CellIterator.php