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

[Source view]

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

(no description)

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

Defines 1 class

WorksheetManager:: (10 methods):
  __construct()
  getSharedStringsManager()
  startSheet()
  throwIfSheetFilePointerIsNotAvailable()
  addRow()
  addNonEmptyRow()
  applyStyleAndRegister()
  getCellXML()
  getCellXMLFragmentForNonEmptyString()
  close()


Class: WorksheetManager  - X-Ref

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

__construct(OptionsManagerInterface $optionsManager,RowManager $rowManager,StyleManager $styleManager,StyleMerger $styleMerger,SharedStringsManager $sharedStringsManager,XLSXEscaper $stringsEscaper,StringHelper $stringHelper,InternalEntityFactory $entityFactory)   X-Ref
WorksheetManager constructor.

param: OptionsManagerInterface $optionsManager
param: RowManager $rowManager
param: StyleManager $styleManager
param: StyleMerger $styleMerger
param: SharedStringsManager $sharedStringsManager
param: XLSXEscaper $stringsEscaper
param: StringHelper $stringHelper
param: InternalEntityFactory $entityFactory

getSharedStringsManager()   X-Ref

return: SharedStringsManager

startSheet(Worksheet $worksheet)   X-Ref
{@inheritdoc}


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

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


addNonEmptyRow(Worksheet $worksheet, Row $row)   X-Ref
Adds non empty row to the worksheet.

param: Worksheet $worksheet The worksheet to add the row to
param: Row $row The row to be written
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

getCellXML($rowIndexOneBased, $columnIndexZeroBased, Cell $cell, $styleId)   X-Ref
Builds and returns xml for a single cell.

param: int  $rowIndexOneBased
param: int  $columnIndexZeroBased
param: Cell $cell
param: int  $styleId
return: string

getCellXMLFragmentForNonEmptyString($cellValue)   X-Ref
Returns the XML fragment for a cell containing a non empty string

param: string $cellValue The cell value
return: string The XML fragment representing the cell

close(Worksheet $worksheet)   X-Ref
{@inheritdoc}