Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401]

(no description)

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

Defines 1 class

WriterEntityFactory:: (8 methods):
  createWriter()
  createWriterFromFile()
  createCSVWriter()
  createXLSXWriter()
  createODSWriter()
  createRow()
  createRowFromArray()
  createCell()


Class: WriterEntityFactory  - X-Ref

Class WriterEntityFactory
Factory to create external entities

createWriter($writerType)   X-Ref
This creates an instance of the appropriate writer, given the type of the file to be written

param: string $writerType Type of the writer to instantiate
return: WriterInterface

createWriterFromFile(string $path)   X-Ref
This creates an instance of the appropriate writer, given the extension of the file to be written

param: string $path The path to the spreadsheet file. Supported extensions are .csv, .ods and .xlsx
return: WriterInterface

createCSVWriter()   X-Ref
This creates an instance of a CSV writer

return: \Box\Spout\Writer\CSV\Writer

createXLSXWriter()   X-Ref
This creates an instance of a XLSX writer

return: \Box\Spout\Writer\XLSX\Writer

createODSWriter()   X-Ref
This creates an instance of a ODS writer

return: \Box\Spout\Writer\ODS\Writer

createRow(array $cells = [], Style $rowStyle = null)   X-Ref

param: Cell[] $cells
param: Style|null $rowStyle
return: Row

createRowFromArray(array $cellValues = [], Style $rowStyle = null)   X-Ref

param: array $cellValues
param: Style|null $rowStyle
return: Row

createCell($cellValue, Style $cellStyle = null)   X-Ref

param: mixed $cellValue
param: Style|null $cellStyle
return: Cell