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.
/lib/spout/src/Spout/Reader/XLSX/Manager/ -> SheetManager.php (source)

[Source view]

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

(no description)

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

Defines 1 class

SheetManager:: (8 methods):
  __construct()
  getSheets()
  processWorkbookPropertiesStartingNode()
  processWorkbookViewStartingNode()
  processSheetStartingNode()
  processSheetsEndingNode()
  getSheetFromSheetXMLNode()
  getSheetDataXMLFilePathForSheetId()


Class: SheetManager  - X-Ref

Class SheetManager
This class manages XLSX sheets

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

param: string $filePath Path of the XLSX file being read
param: \Box\Spout\Common\Manager\OptionsManagerInterface $optionsManager Reader's options manager
param: \Box\Spout\Reader\XLSX\Manager\SharedStringsManager $sharedStringsManager Manages shared strings
param: \Box\Spout\Common\Helper\Escaper\XLSX $escaper Used to unescape XML data
param: InternalEntityFactory $entityFactory Factory to create entities
param: mixed $sharedStringsManager

getSheets()   X-Ref
Returns the sheets metadata of the file located at the previously given file path.
The paths to the sheets' data are read from the [Content_Types].xml file.

return: Sheet[] Sheets within the XLSX file

processWorkbookPropertiesStartingNode($xmlReader)   X-Ref

param: \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XMLReader object, positioned on a "<workbookPr>" starting node
return: int A return code that indicates what action should the processor take next

processWorkbookViewStartingNode($xmlReader)   X-Ref

param: \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XMLReader object, positioned on a "<workbookView>" starting node
return: int A return code that indicates what action should the processor take next

processSheetStartingNode($xmlReader)   X-Ref

param: \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XMLReader object, positioned on a "<sheet>" starting node
return: int A return code that indicates what action should the processor take next

processSheetsEndingNode()   X-Ref

return: int A return code that indicates what action should the processor take next

getSheetFromSheetXMLNode($xmlReaderOnSheetNode, $sheetIndexZeroBased, $isSheetActive)   X-Ref
Returns an instance of a sheet, given the XML node describing the sheet - from "workbook.xml".
We can find the XML file path describing the sheet inside "workbook.xml.res", by mapping with the sheet ID
("r:id" in "workbook.xml", "Id" in "workbook.xml.res").

param: \Box\Spout\Reader\Wrapper\XMLReader $xmlReaderOnSheetNode XML Reader instance, pointing on the node describing the sheet, as defined in "workbook.xml"
param: int $sheetIndexZeroBased Index of the sheet, based on order of appearance in the workbook (zero-based)
param: bool $isSheetActive Whether this sheet was defined as active
return: \Box\Spout\Reader\XLSX\Sheet Sheet instance

getSheetDataXMLFilePathForSheetId($sheetId)   X-Ref

param: string $sheetId The sheet ID, as defined in "workbook.xml"
return: string The XML file path describing the sheet inside "workbook.xml.res", for the given sheet ID