class PHPExcel_Worksheet_RowCellIterator extends PHPExcel_Worksheet_CellIterator implements Iterator

PHPExcelWorksheetRowCellIterator

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Methods

__destruct()

Destructor

boolean
getIterateOnlyExistingCells()

Get loop only existing cells

setIterateOnlyExistingCells(boolean $value = true)

Set the iterator to loop only existing cells

__construct(PHPExcel_Worksheet $subject = null, integer $rowIndex = 1, string $startColumn = 'A', string $endColumn = null)

Create a new column iterator

resetStart(integer $startColumn = 'A')

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

resetEnd(string $endColumn = null)

(Re)Set the end column

seek(string $column = 'A')

Set the column pointer to the selected column

rewind()

Rewind the iterator to the starting column

current()

Return the current cell in this worksheet row

string
key()

Return the current iterator key

next()

Set the iterator to its next value

prev()

Set the iterator to its previous value

boolean
valid()

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

Details

at line 80
__destruct()

Destructor

boolean getIterateOnlyExistingCells()

Get loop only existing cells

Return Value

boolean

setIterateOnlyExistingCells(boolean $value = true)

Set the iterator to loop only existing cells

Parameters

boolean $value

Exceptions

PHPExcel_Exception

at line 68
__construct(PHPExcel_Worksheet $subject = null, integer $rowIndex = 1, string $startColumn = 'A', string $endColumn = null)

Create a new column iterator

Parameters

PHPExcel_Worksheet $subject The worksheet to iterate over
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

at line 92
PHPExcel_Worksheet_RowCellIterator resetStart(integer $startColumn = 'A')

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

Parameters

integer $startColumn The column address at which to start iterating

Return Value

PHPExcel_Worksheet_RowCellIterator

Exceptions

PHPExcel_Exception

at line 109
PHPExcel_Worksheet_RowCellIterator resetEnd(string $endColumn = null)

(Re)Set the end column

Parameters

string $endColumn The column address at which to stop iterating

Return Value

PHPExcel_Worksheet_RowCellIterator

Exceptions

PHPExcel_Exception

at line 125
PHPExcel_Worksheet_RowCellIterator seek(string $column = 'A')

Set the column pointer to the selected column

Parameters

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

Return Value

PHPExcel_Worksheet_RowCellIterator

Exceptions

PHPExcel_Exception

at line 141
rewind()

Rewind the iterator to the starting column

at line 151
PHPExcel_Cell current()

Return the current cell in this worksheet row

Return Value

PHPExcel_Cell

at line 161
string key()

Return the current iterator key

Return Value

string

at line 169
next()

Set the iterator to its next value

at line 183
prev()

Set the iterator to its previous value

Exceptions

PHPExcel_Exception

at line 205
boolean valid()

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

Return Value

boolean