class PHPExcel_Worksheet_RowIterator implements Iterator

PHPExcelWorksheetRowIterator

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

__construct(PHPExcel_Worksheet $subject, integer $startRow = 1, integer $endRow = null)

Create a new row iterator

__destruct()

Destructor

resetStart(integer $startRow = 1)

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

resetEnd(integer $endRow = null)

(Re)Set the end row

seek(integer $row = 1)

Set the row pointer to the selected row

rewind()

Rewind the iterator to the starting row

current()

Return the current row in this worksheet

int
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 rows exist in the worksheet range of rows that we're iterating

Details

at line 76
__construct(PHPExcel_Worksheet $subject, integer $startRow = 1, integer $endRow = null)

Create a new row iterator

Parameters

PHPExcel_Worksheet $subject The worksheet to iterate over
integer $startRow The row number at which to start iterating
integer $endRow Optionally, the row number at which to stop iterating

at line 87
__destruct()

Destructor

at line 99
PHPExcel_Worksheet_RowIterator resetStart(integer $startRow = 1)

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

Parameters

integer $startRow The row number at which to start iterating

Return Value

PHPExcel_Worksheet_RowIterator

Exceptions

PHPExcel_Exception

at line 120
PHPExcel_Worksheet_RowIterator resetEnd(integer $endRow = null)

(Re)Set the end row

Parameters

integer $endRow The row number at which to stop iterating

Return Value

PHPExcel_Worksheet_RowIterator

at line 134
PHPExcel_Worksheet_RowIterator seek(integer $row = 1)

Set the row pointer to the selected row

Parameters

integer $row The row number to set the current pointer at

Return Value

PHPExcel_Worksheet_RowIterator

Exceptions

PHPExcel_Exception

at line 147
rewind()

Rewind the iterator to the starting row

at line 157
PHPExcel_Worksheet_Row current()

Return the current row in this worksheet

Return Value

PHPExcel_Worksheet_Row

at line 167
int key()

Return the current iterator key

Return Value

int

at line 175
next()

Set the iterator to its next value

at line 183
prev()

Set the iterator to its previous value

at line 197
boolean valid()

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

Return Value

boolean