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: | 289 lines (9 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
AbstractWorkbookManager:: (17 methods):
__construct()
addNewSheetAndMakeItCurrent()
getWorksheets()
getCurrentWorksheet()
setCurrentSheet()
addRowToCurrentWorksheet()
close()
closeRemainingObjects()
getWorksheetFilePath()
cleanupTempFolder()
addNewSheet()
setCurrentWorksheet()
getWorksheetFromExternalSheet()
hasCurrentWorksheetReachedMaxRows()
addRowToWorksheet()
applyDefaultRowStyle()
closeAllWorksheets()
Class: AbstractWorkbookManager - X-Ref
| __construct(Workbook $workbook,AbstractOptions $options,WorksheetManagerInterface $worksheetManager,StyleManagerInterface $styleManager,StyleMerger $styleMerger,FileSystemWithRootFolderHelperInterface $fileSystemHelper) X-Ref |
| No description |
| addNewSheetAndMakeItCurrent() X-Ref |
| Creates a new sheet in the workbook and make it the current sheet. The writing will resume where it stopped (i.e. data won't be truncated). return: Worksheet The created sheet |
| getWorksheets() X-Ref |
return: Worksheet[] All the workbook's sheets |
| getCurrentWorksheet() X-Ref |
| Returns the current sheet. return: Worksheet The current sheet |
| setCurrentSheet(Sheet $sheet) X-Ref |
| Sets the given sheet as the current one. New data will be written to this sheet. The writing will resume where it stopped (i.e. data won't be truncated). param: Sheet $sheet The "external" sheet to set as current |
| addRowToCurrentWorksheet(Row $row) X-Ref |
| Adds a row to the current sheet. If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination with the creation of new worksheets if one worksheet has reached its maximum capicity. param: Row $row The row to be added |
| close($finalFilePointer) X-Ref |
| Closes the workbook and all its associated sheets. All the necessary files are written to disk and zipped together to create the final file. All the temporary files are then deleted. param: resource $finalFilePointer Pointer to the spreadsheet that will be created |
| closeRemainingObjects() X-Ref |
| Closes custom objects that are still opened. |
| getWorksheetFilePath(Sheet $sheet) X-Ref |
return: string The file path where the data for the given sheet will be stored |
| cleanupTempFolder() X-Ref |
| Deletes the root folder created in the temp folder and all its contents. |
| addNewSheet() X-Ref |
| Creates a new sheet in the workbook. The current sheet remains unchanged. return: Worksheet The created sheet |
| setCurrentWorksheet(Worksheet $worksheet) X-Ref |
| No description |
| getWorksheetFromExternalSheet(Sheet $sheet) X-Ref |
| Returns the worksheet associated to the given external sheet. return: null|Worksheet the worksheet associated to the given external sheet or null if not found |
| hasCurrentWorksheetReachedMaxRows() X-Ref |
return: bool whether the current worksheet has reached the maximum number of rows per sheet |
| addRowToWorksheet(Worksheet $worksheet, Row $row) X-Ref |
| Adds a row to the given sheet. param: Worksheet $worksheet Worksheet to write the row to param: Row $row The row to be added |
| applyDefaultRowStyle(Row $row) X-Ref |
| No description |
| closeAllWorksheets() X-Ref |
| Closes all workbook's associated sheets. |
