Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 402 and 403]

(no description)

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

Defines 1 class

SheetIterator:: (9 methods):
  __construct()
  rewind()
  valid()
  next()
  current()
  key()
  readSheetsVisibility()
  isSheetActive()
  isSheetVisible()


Class: SheetIterator  - X-Ref


__construct(string $filePath,Options $options,ODS $escaper,SettingsHelper $settingsHelper)   X-Ref
No description

rewind()   X-Ref
Rewind the Iterator to the first element.


valid()   X-Ref
Checks if current position is valid.


next()   X-Ref
Move forward to next element.


current()   X-Ref
Return the current element.


key()   X-Ref
Return the key of the current element.


readSheetsVisibility()   X-Ref
Extracts the visibility of the sheets.

return: array<string, bool> Associative array [STYLE_NAME] => [IS_SHEET_VISIBLE]

isSheetActive(string $sheetName, int $sheetIndex, ?string $activeSheetName)   X-Ref
Returns whether the current sheet was defined as the active one.

param: string      $sheetName       Name of the current sheet
param: int         $sheetIndex      Index of the current sheet
param: null|string $activeSheetName Name of the sheet that was defined as active or NULL if none defined
return: bool Whether the current sheet was defined as the active one

isSheetVisible(string $sheetStyleName)   X-Ref
Returns whether the current sheet is visible.

param: string $sheetStyleName Name of the sheet style
return: bool Whether the current sheet is visible