Search moodle.org's
Developer Documentation

See Release Notes

  • 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.
/lib/openspout/src/Writer/ -> AbstractWriterMultiSheets.php (source)

[Source view]

Differences Between: [Versions 402 and 403]

(no description)

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

Defines 1 class

AbstractWriterMultiSheets:: (8 methods):
  getSheets()
  addNewSheetAndMakeItCurrent()
  getCurrentSheet()
  setCurrentSheet()
  openWriter()
  addRowToWriter()
  closeWriter()
  throwIfWorkbookIsNotAvailable()


Class: AbstractWriterMultiSheets  - X-Ref

getSheets()   X-Ref
Returns all the workbook's sheets.

return: Sheet[] All the workbook's sheets

addNewSheetAndMakeItCurrent()   X-Ref
Creates a new sheet and make it the current sheet. The data will now be written to this sheet.

return: Sheet The created sheet

getCurrentSheet()   X-Ref
Returns the current sheet.

return: Sheet 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 sheet to set as current

openWriter()   X-Ref
{@inheritdoc}


addRowToWriter(Row $row)   X-Ref
{@inheritdoc}


closeWriter()   X-Ref
{@inheritdoc}


throwIfWorkbookIsNotAvailable()   X-Ref
Checks if the workbook has been created. Throws an exception if not created yet.