PhpOffice\PhpSpreadsheet\Worksheet\RowIterator Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Worksheet\RowIterator:

Public Member Functions
	__construct (Worksheet $subject, int $startRow=1, ?int $endRow=null)
	Create a new row iterator.
	current ()
	Return the current row in this worksheet.
	key ()
	Return the current iterator key.
	next ()
	Set the iterator to its next value.
	prev ()
	Set the iterator to its previous value.
	resetEnd (?int $endRow=null)
	(Re)Set the end row.
	resetStart (int $startRow=1)
	(Re)Set the start row and the current row pointer.
	rewind ()
	Rewind the iterator to the starting row.
	seek (int $row=1)
	Set the row pointer to the selected row.
	valid ()
	Indicate if more rows exist in the worksheet range of rows that we're iterating.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::__construct	(	Worksheet	$subject,
		int	$startRow = 1,
		?int	$endRow = null )

Create a new row iterator.

Parameters

Worksheet	$subject	The worksheet to iterate over
int	$startRow	The row number at which to start iterating
?int	$endRow	Optionally, the row number at which to stop iterating

Member Function Documentation

current()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::current

(

)

Return the current row in this worksheet.

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Iterator.

key()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::key

(

)

Return the current iterator key.

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Iterator.

next()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::next

(

)

Set the iterator to its next value.

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Iterator.

resetEnd()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::resetEnd

(

?int

$endRow = null

)

(Re)Set the end row.

Parameters

?int

$endRow

The row number at which to stop iterating

Return values

$this

resetStart()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::resetStart

(

int

$startRow = 1

)

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

Parameters

int

$startRow

The row number at which to start iterating

Return values

$this

rewind()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::rewind

(

)

Rewind the iterator to the starting row.

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Iterator.

seek()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::seek

(

int

$row = 1

)

Set the row pointer to the selected row.

Parameters

int

$row

The row number to set the current pointer at

Return values

$this

valid()

PhpOffice\PhpSpreadsheet\Worksheet\RowIterator::valid

(

)

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

Reimplemented from PhpOffice\PhpSpreadsheet\Worksheet\Iterator.

---

The documentation for this class was generated from the following file:

• lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/Worksheet/RowIterator.php