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.

(no description)

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

Defines 1 class

Sheet:: (6 methods):
  __construct()
  getRowIterator()
  getIndex()
  getName()
  isActive()
  isVisible()


Class: Sheet  - X-Ref

Class Sheet
Represents a sheet within a XLSX file

__construct($rowIterator, $sheetIndex, $sheetName, $isSheetActive, $isSheetVisible)   X-Ref

param: RowIterator $rowIterator The corresponding row iterator
param: int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
param: string $sheetName Name of the sheet
param: bool $isSheetActive Whether the sheet was defined as active
param: bool $isSheetVisible Whether the sheet is visible

getRowIterator()   X-Ref

return: \Box\Spout\Reader\XLSX\RowIterator

getIndex()   X-Ref

return: int Index of the sheet, based on order in the workbook (zero-based)

getName()   X-Ref

return: string Name of the sheet

isActive()   X-Ref

return: bool Whether the sheet was defined as active

isVisible()   X-Ref

return: bool Whether the sheet is visible