\PHPExcel_Worksheet_ColumnIterator

PHPExcel_Worksheet_ColumnIterator

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()
resetStart()
resetEnd()
seek()
rewind()
current()
key()
next()
prev()
valid()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$subject
$position
$startColumn
$endColumn
N/A

Properties

$subject

$subject : \PHPExcel_Worksheet

PHPExcel_Worksheet to iterate

Type

\PHPExcel_Worksheet

$position

$position : integer

Current iterator position

Type

integer

$startColumn

$startColumn : integer

Start position

Type

integer

$endColumn

$endColumn : integer

End position

Type

integer

Methods

__construct()

__construct(\PHPExcel_Worksheet  $subject = null, string  $startColumn = 'A', string  $endColumn = null) 

Create a new column iterator

Parameters

\PHPExcel_Worksheet $subject

The worksheet to iterate over

string $startColumn

The column address at which to start iterating

string $endColumn

Optionally, the column address at which to stop iterating

__destruct()

__destruct() 

Destructor

resetStart()

resetStart(integer  $startColumn = 'A') : \PHPExcel_Worksheet_ColumnIterator

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

Parameters

integer $startColumn

The column address at which to start iterating

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_ColumnIterator

resetEnd()

resetEnd(string  $endColumn = null) : \PHPExcel_Worksheet_ColumnIterator

(Re)Set the end column

Parameters

string $endColumn

The column address at which to stop iterating

Returns

\PHPExcel_Worksheet_ColumnIterator

seek()

seek(string  $column = 'A') : \PHPExcel_Worksheet_ColumnIterator

Set the column pointer to the selected column

Parameters

string $column

The column address to set the current pointer at

Throws

\PHPExcel_Exception

Returns

\PHPExcel_Worksheet_ColumnIterator

rewind()

rewind() 

Rewind the iterator to the starting column

key()

key() : string

Return the current iterator key

Returns

string

next()

next() 

Set the iterator to its next value

prev()

prev() 

Set the iterator to its previous value

Throws

\PHPExcel_Exception

valid()

valid() : boolean

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

Returns

boolean