\PHPExcel_Worksheet_ColumnCellIterator

PHPExcel_Worksheet_ColumnCellIterator

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

Summary

Methods
Properties
Constants
__construct()
__destruct()
rewind()
current()
key()
next()
valid()
getIterateOnlyExistingCells()
setIterateOnlyExistingCells()
resetStart()
resetEnd()
seek()
prev()
No public properties found
No constants found
adjustForExistingOnlyRange()
$columnIndex
$startRow
$endRow
N/A
No private methods found
$_subject
$_rowIndex
$_position
$_onlyExistingCells
N/A

Properties

$columnIndex

$columnIndex : string

Column index

Type

string

$startRow

$startRow : integer

Start position

Type

integer

$endRow

$endRow : integer

End position

Type

integer

$_subject

$_subject : \PHPExcel_Worksheet

PHPExcel_Worksheet to iterate

Type

\PHPExcel_Worksheet

$_rowIndex

$_rowIndex : integer

Row index

Type

integer

$_position

$_position : integer

Current iterator position

Type

integer

$_onlyExistingCells

$_onlyExistingCells : boolean

Loop only existing cells

Type

boolean

Methods

__construct()

__construct(\PHPExcel_Worksheet  $subject = null, string  $columnIndex = 'A', integer  $startRow = 1, integer  $endRow = null) 

Create a new row iterator

Parameters

\PHPExcel_Worksheet $subject

The worksheet to iterate over

string $columnIndex

The column that we want to iterate

integer $startRow

The row number at which to start iterating

integer $endRow

Optionally, the row number at which to stop iterating

__destruct()

__destruct() 

Destructor

rewind()

rewind() 

Rewind the iterator to the starting row

current()

current() : \PHPExcel_Worksheet_Row

Return the current cell in this worksheet column

Returns

\PHPExcel_Worksheet_Row

key()

key() : integer

Return the current iterator key

Returns

integer

next()

next() 

Set the iterator to its next value

valid()

valid() : boolean

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

Returns

boolean

getIterateOnlyExistingCells()

getIterateOnlyExistingCells() : boolean

Get loop only existing cells

Returns

boolean

setIterateOnlyExistingCells()

setIterateOnlyExistingCells(boolean  $value = true) 

Set the iterator to loop only existing cells

Parameters

boolean $value

resetStart()

resetStart(integer  $startRow = 1) : \PHPExcel_Worksheet_ColumnCellIterator

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

Parameters

integer $startRow

The row number at which to start iterating

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_ColumnCellIterator

resetEnd()

resetEnd(integer  $endRow = null) : \PHPExcel_Worksheet_ColumnCellIterator

(Re)Set the end row

Parameters

integer $endRow

The row number at which to stop iterating

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_ColumnCellIterator

seek()

seek(integer  $row = 1) : \PHPExcel_Worksheet_ColumnCellIterator

Set the row pointer to the selected row

Parameters

integer $row

The row number to set the current pointer at

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_ColumnCellIterator

prev()

prev() 

Set the iterator to its previous value

adjustForExistingOnlyRange()

adjustForExistingOnlyRange() 

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

Throws

\PHPExcel_Exception