Inheritance diagram for PHPExcel_Worksheet_RowCellIterator:

Collaboration diagram for PHPExcel_Worksheet_RowCellIterator:

Public Member Functions
	__construct (PHPExcel_Worksheet $subject=null, $rowIndex=1, $startColumn='A', $endColumn=null)

	__destruct ()
	Destructor. More...

	resetStart ($startColumn='A')

	resetEnd ($endColumn=null)

	seek ($column='A')

	rewind ()
	Rewind the iterator to the starting column. More...

	current ()
	Return the current cell in this worksheet row. More...

	key ()
	Return the current iterator key. More...

	next ()
	Set the iterator to its next value. More...

	prev ()

	valid ()
	Indicate if more columns exist in the worksheet range of columns that we're iterating. More...

Public Member Functions inherited from PHPExcel_Worksheet_CellIterator
	__destruct ()
	Destructor. More...

	getIterateOnlyExistingCells ()
	Get loop only existing cells. More...

	setIterateOnlyExistingCells ($value=true)

Protected Member Functions
	adjustForExistingOnlyRange ()

	adjustForExistingOnlyRange ()

Protected Attributes
	$_rowIndex

	$_startColumn = 0

	$_endColumn = 0

Protected Attributes inherited from PHPExcel_Worksheet_CellIterator
	$_subject

	$_position = null

	$_onlyExistingCells = false

Detailed Description

Definition at line 38 of file RowCellIterator.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Worksheet_RowCellIterator::__construct	(	PHPExcel_Worksheet	$subject = `null`,
			$rowIndex = `1`,
			$startColumn = `'A'`,
			$endColumn = `null`
	)

Create a new column iterator

@param      PHPExcel_Worksheet      $subject            The worksheet to iterate over

Parameters

integer	$rowIndex	The row that we want to iterate
string	$startColumn	The column address at which to start iterating
string	$endColumn	Optionally, the column address at which to stop iterating

Definition at line 69 of file RowCellIterator.php.

                                                                                                                              {
                // Set subject and row index
                $this->_subject = $subject;
                $this->_rowIndex = $rowIndex;
                $this->resetEnd($endColumn);
                $this->resetStart($startColumn);
        }

References resetEnd(), and resetStart().

Here is the call graph for this function:

◆ __destruct()

PHPExcel_Worksheet_RowCellIterator::__destruct ( )

Destructor.

Reimplemented from PHPExcel_Worksheet_CellIterator.

Definition at line 80 of file RowCellIterator.php.

                                     {
                unset($this->_subject);
        }

Member Function Documentation

◆ adjustForExistingOnlyRange()

PHPExcel_Worksheet_RowCellIterator::adjustForExistingOnlyRange ( )

protected

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

Exceptions

PHPExcel_Exception

Reimplemented from PHPExcel_Worksheet_CellIterator.

Definition at line 205 of file RowCellIterator.php.

                                                    {
        if ($this->_onlyExistingCells) {
            while ((!$this->_subject->cellExistsByColumnAndRow($this->_startColumn, $this->_rowIndex)) &&
                ($this->_startColumn <= $this->_endColumn)) {
                ++$this->_startColumn;
            }
            if ($this->_startColumn > $this->_endColumn) {
                throw new PHPExcel_Exception('No cells exist within the specified range');
            }
            while ((!$this->_subject->cellExistsByColumnAndRow($this->_endColumn, $this->_rowIndex)) &&
                ($this->_endColumn >= $this->_startColumn)) {
                --$this->_endColumn;
            }
            if ($this->_endColumn < $this->_startColumn) {
                throw new PHPExcel_Exception('No cells exist within the specified range');
            }
        }
    }

References $_endColumn, and $_startColumn.

Referenced by resetEnd(), and resetStart().

Here is the caller graph for this function:

◆ current()

PHPExcel_Worksheet_RowCellIterator::current ( )

Return the current cell in this worksheet row.

Returns: PHPExcel_Cell

Definition at line 146 of file RowCellIterator.php.

                                  {
                return $this->_subject->getCellByColumnAndRow($this->_position, $this->_rowIndex);
        }

◆ key()

PHPExcel_Worksheet_RowCellIterator::key ( )

Return the current iterator key.

Returns: string

Definition at line 155 of file RowCellIterator.php.

                              {
                return PHPExcel_Cell::stringFromColumnIndex($this->_position);
        }

References PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

◆ next()

PHPExcel_Worksheet_RowCellIterator::next ( )

Set the iterator to its next value.

Definition at line 162 of file RowCellIterator.php.

                               {
        do {
            ++$this->_position;
        } while (($this->_onlyExistingCells) &&
            (!$this->_subject->cellExistsByColumnAndRow($this->_position, $this->_rowIndex)) &&
            ($this->_position <= $this->_endColumn));
        }

References PHPExcel_Worksheet_CellIterator\$_position.

◆ prev()

PHPExcel_Worksheet_RowCellIterator::prev ( )

Set the iterator to its previous value

Exceptions

PHPExcel_Exception

Definition at line 175 of file RowCellIterator.php.

                               {
        if ($this->_position <= $this->_startColumn) {
            throw new PHPExcel_Exception(
                "Column is already at the beginning of range (" . 
                PHPExcel_Cell::stringFromColumnIndex($this->_endColumn) . " - " . 
                PHPExcel_Cell::stringFromColumnIndex($this->_endColumn) . ")"
            );
        }
 
        do {
            --$this->_position;
        } while (($this->_onlyExistingCells) &&
            (!$this->_subject->cellExistsByColumnAndRow($this->_position, $this->_rowIndex)) &&
            ($this->_position >= $this->_startColumn));
        }

References PHPExcel_Worksheet_CellIterator\$_position, and PHPExcel_Cell\stringFromColumnIndex().

Here is the call graph for this function:

◆ resetEnd()

PHPExcel_Worksheet_RowCellIterator::resetEnd ( $endColumn = null )

(Re)Set the end column

@param string       $endColumn      The column address at which to stop iterating

Returns: PHPExcel_Worksheet_RowCellIterator

Exceptions

PHPExcel_Exception

Definition at line 107 of file RowCellIterator.php.

                                                    {
                $endColumn = ($endColumn) ? $endColumn : $this->_subject->getHighestColumn();
                $this->_endColumn = PHPExcel_Cell::columnIndexFromString($endColumn) - 1;
        $this->adjustForExistingOnlyRange();
 
        return $this;
        }

References adjustForExistingOnlyRange(), and PHPExcel_Cell\columnIndexFromString().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetStart()

PHPExcel_Worksheet_RowCellIterator::resetStart ( $startColumn = 'A' )

(Re)Set the start column and the current column pointer

@param integer      $startColumn    The column address at which to start iterating

Returns: PHPExcel_Worksheet_RowCellIterator

Exceptions

PHPExcel_Exception

Definition at line 91 of file RowCellIterator.php.

                                                       {
        $startColumnIndex = PHPExcel_Cell::columnIndexFromString($startColumn) - 1;
                $this->_startColumn = $startColumnIndex;
        $this->adjustForExistingOnlyRange();
                $this->seek(PHPExcel_Cell::stringFromColumnIndex($this->_startColumn));
 
        return $this;
        }

References adjustForExistingOnlyRange(), PHPExcel_Cell\columnIndexFromString(), seek(), and PHPExcel_Cell\stringFromColumnIndex().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rewind()

PHPExcel_Worksheet_RowCellIterator::rewind ( )

Rewind the iterator to the starting column.

Definition at line 137 of file RowCellIterator.php.

                                 {
                $this->_position = $this->_startColumn;
        }

References $_startColumn.

◆ seek()

PHPExcel_Worksheet_RowCellIterator::seek ( $column = 'A' )

Set the column pointer to the selected column

@param string       $column The column address to set the current pointer at

Returns: PHPExcel_Worksheet_RowCellIterator

Exceptions

PHPExcel_Exception

Definition at line 122 of file RowCellIterator.php.

                                            {
        $column = PHPExcel_Cell::columnIndexFromString($column) - 1;
        if (($column < $this->_startColumn) || ($column > $this->_endColumn)) {
            throw new PHPExcel_Exception("Column $column is out of range ({$this->_startColumn} - {$this->_endColumn})");
        } elseif ($this->_onlyExistingCells && !($this->_subject->cellExistsByColumnAndRow($column, $this->_rowIndex))) {
            throw new PHPExcel_Exception('In "IterateOnlyExistingCells" mode and Cell does not exist');
        }
                $this->_position = $column;
 
        return $this;
    }

References $column, and PHPExcel_Cell\columnIndexFromString().

Referenced by resetStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valid()

PHPExcel_Worksheet_RowCellIterator::valid ( )

Indicate if more columns exist in the worksheet range of columns that we're iterating.

Returns: boolean

Definition at line 196 of file RowCellIterator.php.

                                {
                return $this->_position <= $this->_endColumn;
        }

References $_endColumn.

Field Documentation

◆ $_endColumn

PHPExcel_Worksheet_RowCellIterator::$_endColumn = 0

protected

Definition at line 59 of file RowCellIterator.php.

Referenced by adjustForExistingOnlyRange(), and valid().

◆ $_rowIndex

PHPExcel_Worksheet_RowCellIterator::$_rowIndex

protected

Definition at line 45 of file RowCellIterator.php.

◆ $_startColumn

PHPExcel_Worksheet_RowCellIterator::$_startColumn = 0

protected

Definition at line 52 of file RowCellIterator.php.

Referenced by adjustForExistingOnlyRange(), and rewind().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Worksheet/RowCellIterator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ adjustForExistingOnlyRange()

◆ current()

◆ key()

◆ next()

◆ prev()

◆ resetEnd()

◆ resetStart()

◆ rewind()

◆ seek()

◆ valid()

Field Documentation

◆ $_endColumn

◆ $_rowIndex

◆ $_startColumn