Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
(no description)
| File Size: | 285 lines (11 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
SheetManager:: (10 methods):
__construct()
getSheets()
processWorkbookPropertiesStartingNode()
processWorkbookViewStartingNode()
processSheetStartingNode()
processSheetsEndingNode()
getSheetFromSheetXMLNode()
getSheetDataXMLFilePathForSheetId()
createRowIterator()
createSheetHeaderReader()
Class: SheetManager - X-Ref
| __construct(string $filePath,Options $options,SharedStringsManager $sharedStringsManager,XLSX $escaper) X-Ref |
| No description |
| 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 $xmlReader) X-Ref |
param: \OpenSpout\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 $xmlReader) X-Ref |
param: \OpenSpout\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 $xmlReader) X-Ref |
param: \OpenSpout\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(XMLReader $xmlReaderOnSheetNode, int $sheetIndexZeroBased, bool $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: \OpenSpout\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: \OpenSpout\Reader\XLSX\Sheet Sheet instance |
| getSheetDataXMLFilePathForSheetId(string $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 |
| createRowIterator(string $filePath,string $sheetDataXMLFilePath,Options $options,SharedStringsManager $sharedStringsManager) X-Ref |
| No description |
| createSheetHeaderReader(string $filePath,string $sheetDataXMLFilePath) X-Ref |
| No description |
