Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/spout/src/Spout/Reader/ODS/ -> SheetIterator.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 39 and 400] [Versions 400 and 401]

(no description)

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

Defines 1 class

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


Class: SheetIterator  - X-Ref

Class SheetIterator
Iterate over ODS sheet.

__construct($filePath, $optionsManager, $escaper, $settingsHelper, $entityFactory)   X-Ref

param: string $filePath Path of the file to be read
param: \Box\Spout\Common\Manager\OptionsManagerInterface $optionsManager
param: \Box\Spout\Common\Helper\Escaper\ODS $escaper Used to unescape XML data
param: SettingsHelper $settingsHelper Helper to get data from "settings.xml"
param: InternalEntityFactory $entityFactory Factory to create entities

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

return: void

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

return: array Associative array [STYLE_NAME] => [IS_SHEET_VISIBLE]

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

return: bool

next()   X-Ref
Move forward to next element

return: void

current()   X-Ref
Return the current element

return: \Box\Spout\Reader\ODS\Sheet

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

return: bool 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: string|null $activeSheetName Name of the sheet that was defined as active or NULL if none defined

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

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

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

return: int

end()   X-Ref
Cleans up what was created to iterate over the object.

return: void