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/ -> WriterAbstract.php (source)

[Source view]

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

(no description)

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

Defines 1 class

WriterAbstract:: (10 methods):
  __construct()
  setDefaultRowStyle()
  openToFile()
  openToBrowser()
  throwIfFilePointerIsNotAvailable()
  throwIfWriterAlreadyOpened()
  addRow()
  addRows()
  close()
  closeAndAttemptToCleanupAllFiles()


Class: WriterAbstract  - X-Ref

Class WriterAbstract

__construct(OptionsManagerInterface $optionsManager,GlobalFunctionsHelper $globalFunctionsHelper,HelperFactory $helperFactory)   X-Ref

param: OptionsManagerInterface $optionsManager
param: GlobalFunctionsHelper $globalFunctionsHelper
param: HelperFactory $helperFactory

setDefaultRowStyle(Style $defaultStyle)   X-Ref
{@inheritdoc}


openToFile($outputFilePath)   X-Ref
{@inheritdoc}


openToBrowser($outputFileName)   X-Ref


throwIfFilePointerIsNotAvailable()   X-Ref
Checks if the pointer to the file/stream to write to is available.
Will throw an exception if not available.

return: void

throwIfWriterAlreadyOpened($message)   X-Ref
Checks if the writer has already been opened, since some actions must be done before it gets opened.
Throws an exception if already opened.

param: string $message Error message
return: void

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


addRows(array $rows)   X-Ref
{@inheritdoc}


close()   X-Ref
{@inheritdoc}


closeAndAttemptToCleanupAllFiles()   X-Ref
Closes the writer and attempts to cleanup all files that were
created during the writing process (temp files & final file).

return: void