Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/lib/phpspreadsheet/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/ -> RowCellIterator.php (source)

[Source view]

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

(no description)

File Size: 191 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

RowCellIterator:: (12 methods):
  __construct()
  resetStart()
  resetEnd()
  seek()
  rewind()
  current()
  key()
  next()
  prev()
  valid()
  getCurrentColumnIndex()
  adjustForExistingOnlyRange()


Class: RowCellIterator  - X-Ref

__construct(?Worksheet $worksheet = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)   X-Ref
Create a new column iterator.

param: Worksheet $worksheet The worksheet to iterate over
param: int $rowIndex The row that we want to iterate
param: string $startColumn The column address at which to start iterating
param: string $endColumn Optionally, the column address at which to stop iterating

resetStart($startColumn = 'A')   X-Ref
(Re)Set the start column and the current column pointer.

param: string $startColumn The column address at which to start iterating
return: $this

resetEnd($endColumn = null)   X-Ref
(Re)Set the end column.

param: string $endColumn The column address at which to stop iterating
return: $this

seek($column = 'A')   X-Ref
Set the column pointer to the selected column.

param: string $column The column address to set the current pointer at
return: $this

rewind()   X-Ref
Rewind the iterator to the starting column.


current()   X-Ref
Return the current cell in this worksheet row.

return: \PhpOffice\PhpSpreadsheet\Cell\Cell

key()   X-Ref
Return the current iterator key.

return: string

next()   X-Ref
Set the iterator to its next value.


prev()   X-Ref
Set the iterator to its previous value.


valid()   X-Ref
Indicate if more columns exist in the worksheet range of columns that we're iterating.

return: bool

getCurrentColumnIndex()   X-Ref
Return the current iterator position.

return: int

adjustForExistingOnlyRange()   X-Ref
Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.