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/phpspreadsheet/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/ -> NumberFormat.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

(no description)

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

Defines 1 class

NumberFormat:: (14 methods):
  __construct()
  getSharedComponent()
  getStyleArray()
  applyFromArray()
  getFormatCode()
  setFormatCode()
  getBuiltInFormatCode()
  setBuiltInFormatCode()
  fillBuiltInFormatCodes()
  builtInFormatCode()
  builtInFormatCodeIndex()
  getHashCode()
  toFormattedString()
  exportArray1()


Class: NumberFormat  - X-Ref

__construct($isSupervisor = false, $isConditional = false)   X-Ref
Create a new NumberFormat.

param: bool $isSupervisor Flag indicating if this is a supervisor or not
param: bool $isConditional Flag indicating if this is a conditional style or not

getSharedComponent()   X-Ref
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor.

return: NumberFormat

getStyleArray($array)   X-Ref
Build style array from subcomponents.

param: array $array
return: array

applyFromArray(array $styleArray)   X-Ref
Apply styles from array.

<code>
$spreadsheet->getActiveSheet()->getStyle('B2')->getNumberFormat()->applyFromArray(
[
'formatCode' => NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE
]
);
</code>

param: array $styleArray Array containing style information
return: $this

getFormatCode()   X-Ref
Get Format Code.

return: null|string

setFormatCode($formatCode)   X-Ref
Set Format Code.

param: string $formatCode see self::FORMAT_*
return: $this

getBuiltInFormatCode()   X-Ref
Get Built-In Format Code.

return: false|int

setBuiltInFormatCode($formatCodeIndex)   X-Ref
Set Built-In Format Code.

param: int $formatCodeIndex
return: $this

fillBuiltInFormatCodes()   X-Ref
Fill built-in format codes.


builtInFormatCode($index)   X-Ref
Get built-in format code.

param: int $index
return: string

builtInFormatCodeIndex($formatCodeIndex)   X-Ref
Get built-in format code index.

param: string $formatCodeIndex
return: false|int

getHashCode()   X-Ref
Get hash code.

return: string Hash code

toFormattedString($value, $format, $callBack = null)   X-Ref
Convert a value in a pre-defined format to a PHP string.

param: mixed $value Value to format
param: string $format Format code, see = self::FORMAT_*
param: array $callBack Callback function for additional formatting of string
return: string Formatted string

exportArray1()   X-Ref
No description