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/Writer/Common/Manager/ -> WorkbookManagerAbstract.php (source)

[Source view]

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

(no description)

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

Defines 1 class

WorkbookManagerAbstract:: (17 methods):
  __construct()
  getWorkbook()
  addNewSheetAndMakeItCurrent()
  addNewSheet()
  getWorksheets()
  getCurrentWorksheet()
  setCurrentSheet()
  setCurrentWorksheet()
  getWorksheetFromExternalSheet()
  addRowToCurrentWorksheet()
  hasCurrentWorksheetReachedMaxRows()
  addRowToWorksheet()
  applyDefaultRowStyle()
  close()
  closeRemainingObjects()
  closeAllWorksheets()
  cleanupTempFolder()


Class: WorkbookManagerAbstract  - X-Ref

Class WorkbookManagerAbstract
Abstract workbook manager, providing the generic interfaces to work with workbook.

__construct(Workbook $workbook,OptionsManagerInterface $optionsManager,WorksheetManagerInterface $worksheetManager,StyleManagerInterface $styleManager,StyleMerger $styleMerger,FileSystemWithRootFolderHelperInterface $fileSystemHelper,InternalEntityFactory $entityFactory,ManagerFactoryInterface $managerFactory)   X-Ref

param: Workbook $workbook
param: OptionsManagerInterface $optionsManager
param: WorksheetManagerInterface $worksheetManager
param: StyleManagerInterface $styleManager
param: StyleMerger $styleMerger
param: FileSystemWithRootFolderHelperInterface $fileSystemHelper
param: InternalEntityFactory $entityFactory
param: ManagerFactoryInterface $managerFactory

getWorkbook()   X-Ref

return: Workbook

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

addNewSheet()   X-Ref
Creates a new sheet in the workbook. The current sheet remains unchanged.

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
return: void

setCurrentWorksheet($worksheet)   X-Ref

param: Worksheet $worksheet
return: void

getWorksheetFromExternalSheet($sheet)   X-Ref
Returns the worksheet associated to the given external sheet.

param: Sheet $sheet
return: Worksheet|null The worksheet associated to the given external sheet or null if not found.

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
return: void

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
return: void

applyDefaultRowStyle(Row $row)   X-Ref

param: Row $row

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
return: void

closeRemainingObjects()   X-Ref
Closes custom objects that are still opened

return: void

closeAllWorksheets()   X-Ref
Closes all workbook's associated sheets.

return: void

cleanupTempFolder()   X-Ref
Deletes the root folder created in the temp folder and all its contents.

return: void