\PHPExcel_Worksheet_RowIterator

PHPExcel_Worksheet_RowIterator

Used to iterate rows in a PHPExcel_Worksheet

Summary

Methods
Properties
Constants
__construct()
__destruct()
resetStart()
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
$_startRow
N/A

Properties

$_subject

$_subject : \PHPExcel_Worksheet

PHPExcel_Worksheet to iterate

Type

PHPExcel_Worksheet

$_position

$_position : int

Current iterator position

Type

int

$_startRow

$_startRow : int

Start position

Type

int

Methods

__construct()

__construct(\PHPExcel_Worksheet  $subject = null, int  $startRow = 1) : mixed

Create a new row iterator

Parameters

\PHPExcel_Worksheet $subject

The worksheet to iterate over

int $startRow

The row number at which to start iterating

Returns

mixed —

__destruct()

__destruct() : mixed

Destructor

Returns

mixed —

resetStart()

resetStart(int  $startRow = 1) : mixed

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

Parameters

int $startRow

The row number at which to start iterating

Returns

mixed —

seek()

seek(int  $row = 1) : mixed

Set the row pointer to the selected row

Parameters

int $row

The row number to set the current pointer at

Returns

mixed —

rewind()

rewind() : mixed

Rewind the iterator to the starting row

Returns

mixed —

current()

current() : \PHPExcel_Worksheet_Row

Return the current row in this worksheet

Returns

\PHPExcel_Worksheet_Row —

key()

key() : int

Return the current iterator key

Returns

int —

next()

next() : mixed

Set the iterator to its next value

Returns

mixed —

prev()

prev() : mixed

Set the iterator to its previous value

Returns

mixed —

valid()

valid() : bool

Indicate if more rows exist in the worksheet

Returns

bool —