Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

(no description)

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

Defines 1 class

Reader:: (6 methods):
  __construct()
  setTempFolder()
  doesSupportStreamWrapper()
  openReader()
  getConcreteSheetIterator()
  closeReader()


Class: Reader  - X-Ref

Class Reader
This class provides support to read data from a XLSX file

__construct(OptionsManagerInterface $optionsManager,GlobalFunctionsHelper $globalFunctionsHelper,InternalEntityFactoryInterface $entityFactory,ManagerFactory $managerFactory)   X-Ref

param: OptionsManagerInterface $optionsManager
param: GlobalFunctionsHelper $globalFunctionsHelper
param: InternalEntityFactoryInterface $entityFactory
param: ManagerFactory $managerFactory

setTempFolder($tempFolder)   X-Ref

param: string $tempFolder Temporary folder where the temporary files will be created
return: Reader

doesSupportStreamWrapper()   X-Ref
Returns whether stream wrappers are supported

return: bool

openReader($filePath)   X-Ref
Opens the file at the given file path to make it ready to be read.
It also parses the sharedStrings.xml file to get all the shared strings available in memory
and fetches all the available sheets.

param: string $filePath Path of the file to be read
return: void

getConcreteSheetIterator()   X-Ref
Returns an iterator to iterate over sheets.

return: SheetIterator To iterate over sheets

closeReader()   X-Ref
Closes the reader. To be used after reading the file.

return: void