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/ODS/Manager/ -> WorksheetManager.php (source)

[Source view]

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

(no description)

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

Defines 1 class

WorksheetManager:: (9 methods):
  __construct()
  startSheet()
  throwIfSheetFilePointerIsNotAvailable()
  getTableElementStartAsString()
  addRow()
  applyStyleAndRegister()
  getCellXMLWithStyle()
  getCellXML()
  close()


Class: WorksheetManager  - X-Ref

Class WorksheetManager
ODS worksheet manager, providing the interfaces to work with ODS worksheets.

__construct(StyleManager $styleManager,StyleMerger $styleMerger,ODSEscaper $stringsEscaper,StringHelper $stringHelper)   X-Ref
WorksheetManager constructor.

param: StyleManager $styleManager
param: StyleMerger $styleMerger
param: ODSEscaper $stringsEscaper
param: StringHelper $stringHelper

startSheet(Worksheet $worksheet)   X-Ref
Prepares the worksheet to accept data

param: Worksheet $worksheet The worksheet to start
return: void

throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)   X-Ref
Checks if the sheet has been sucessfully created. Throws an exception if not.

param: bool|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
return: void

getTableElementStartAsString(Worksheet $worksheet)   X-Ref
Returns the table XML root node as string.

param: Worksheet $worksheet
return: string <table> node as string

addRow(Worksheet $worksheet, Row $row)   X-Ref
Adds a row to the given worksheet.

param: Worksheet $worksheet The worksheet to add the row to
param: Row $row The row to be added
return: void

applyStyleAndRegister(Cell $cell, Style $rowStyle)   X-Ref
Applies styles to the given style, merging the cell's style with its row's style

param: Cell $cell
param: Style $rowStyle
return: RegisteredStyle

getCellXMLWithStyle(Cell $cell, Style $style, int $currentCellIndex, int $nextCellIndex)   X-Ref
No description

getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)   X-Ref
Returns the cell XML content, given its value.

param: Cell $cell The cell to be written
param: int $styleIndex Index of the used style
param: int $numTimesValueRepeated Number of times the value is consecutively repeated
return: string The cell XML content

close(Worksheet $worksheet)   X-Ref
Closes the worksheet

param: Worksheet $worksheet
return: void