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/Reader/ODS/Helper/ -> CellValueFormatter.php (source)

[Source view]

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

(no description)

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

Defines 1 class

CellValueFormatter:: (12 methods):
  __construct()
  extractAndFormatNodeValue()
  formatStringCellValue()
  extractTextValueFromNode()
  isWhitespaceNode()
  transformWhitespaceNode()
  formatFloatCellValue()
  formatBooleanCellValue()
  formatDateCellValue()
  formatTimeCellValue()
  formatCurrencyCellValue()
  formatPercentageCellValue()


Class: CellValueFormatter  - X-Ref

Class CellValueFormatter
This class provides helper functions to format cell values

__construct($shouldFormatDates, $escaper)   X-Ref

param: bool $shouldFormatDates Whether date/time values should be returned as PHP objects or be formatted as strings
param: \Box\Spout\Common\Helper\Escaper\ODS $escaper Used to unescape XML data

extractAndFormatNodeValue($node)   X-Ref
Returns the (unescaped) correctly marshalled, cell value associated to the given XML node.

param: \DOMNode $node
return: string|int|float|bool|\DateTime|\DateInterval The value associated with the cell, empty string if cell's type is void/undefined

formatStringCellValue($node)   X-Ref
Returns the cell String value.

param: \DOMNode $node
return: string The value associated with the cell

extractTextValueFromNode($pNode)   X-Ref

param: $pNode
return: string

isWhitespaceNode($nodeName)   X-Ref
Returns whether the given node is a whitespace node. It must be one of these:
- <text:s />
- <text:tab />
- <text:line-break />

param: string $nodeName
return: bool

transformWhitespaceNode($node)   X-Ref
The "<text:p>" node can contain the string value directly
or contain child elements. In this case, whitespaces contain in
the child elements should be replaced by their XML equivalent:
- space => <text:s />
- tab => <text:tab />
- line break => <text:line-break />

param: \DOMNode $node The XML node representing a whitespace
return: string The corresponding whitespace value

formatFloatCellValue($node)   X-Ref
Returns the cell Numeric value from the given node.

param: \DOMNode $node
return: int|float The value associated with the cell

formatBooleanCellValue($node)   X-Ref
Returns the cell Boolean value from the given node.

param: \DOMNode $node
return: bool The value associated with the cell

formatDateCellValue($node)   X-Ref
Returns the cell Date value from the given node.

param: \DOMNode $node
return: \DateTime|string The value associated with the cell

formatTimeCellValue($node)   X-Ref
Returns the cell Time value from the given node.

param: \DOMNode $node
return: \DateInterval|string The value associated with the cell

formatCurrencyCellValue($node)   X-Ref
Returns the cell Currency value from the given node.

param: \DOMNode $node
return: string The value associated with the cell (e.g. "100 USD" or "9.99 EUR")

formatPercentageCellValue($node)   X-Ref
Returns the cell Percentage value from the given node.

param: \DOMNode $node
return: int|float The value associated with the cell