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.

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: 192 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ColumnCellIterator:: (11 methods):
  __construct()
  resetStart()
  resetEnd()
  seek()
  rewind()
  current()
  key()
  next()
  prev()
  valid()
  adjustForExistingOnlyRange()


Class: ColumnCellIterator  - X-Ref

__construct(?Worksheet $subject = null, $columnIndex = 'A', $startRow = 1, $endRow = null)   X-Ref
Create a new row iterator.

param: Worksheet $subject The worksheet to iterate over
param: string $columnIndex The column that we want to iterate
param: int $startRow The row number at which to start iterating
param: int $endRow Optionally, the row number at which to stop iterating

resetStart($startRow = 1)   X-Ref
(Re)Set the start row and the current row pointer.

param: int $startRow The row number at which to start iterating
return: $this

resetEnd($endRow = null)   X-Ref
(Re)Set the end row.

param: int $endRow The row number at which to stop iterating
return: $this

seek($row = 1)   X-Ref
Set the row pointer to the selected row.

param: int $row The row number to set the current pointer at
return: $this

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


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

return: \PhpOffice\PhpSpreadsheet\Cell\Cell

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

return: int

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 rows exist in the worksheet range of rows that we're iterating.

return: bool

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