Developer Documentation
- Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
- Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
- PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]
(no description)
| File Size: | 881 lines (31 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
NumberFormat:: (26 methods):
__construct()
getSharedComponent()
getStyleArray()
applyFromArray()
getFormatCode()
setFormatCode()
getBuiltInFormatCode()
setBuiltInFormatCode()
fillBuiltInFormatCodes()
builtInFormatCode()
builtInFormatCodeIndex()
getHashCode()
setLowercaseCallback()
escapeQuotesCallback()
formatAsDate()
formatAsPercentage()
formatAsFraction()
mergeComplexNumberFormatMasks()
processComplexNumberFormatMask()
complexNumberFormatMask()
formatStraightNumericValue()
formatAsNumber()
splitFormatCompare()
splitFormat()
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 $pStyles) X-Ref |
| Apply styles from array. <code> $spreadsheet->getActiveSheet()->getStyle('B2')->getNumberFormat()->applyFromArray( [ 'formatCode' => NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE ] ); </code> param: array $pStyles Array containing style information return: $this |
| getFormatCode() X-Ref |
| Get Format Code. return: string |
| setFormatCode($pValue) X-Ref |
| Set Format Code. param: string $pValue see self::FORMAT_* return: $this |
| getBuiltInFormatCode() X-Ref |
| Get Built-In Format Code. return: int |
| setBuiltInFormatCode($pValue) X-Ref |
| Set Built-In Format Code. param: int $pValue return: $this |
| fillBuiltInFormatCodes() X-Ref |
| Fill built-in format codes. |
| builtInFormatCode($pIndex) X-Ref |
| Get built-in format code. param: int $pIndex return: string |
| builtInFormatCodeIndex($formatCode) X-Ref |
| Get built-in format code index. param: string $formatCode return: bool|int |
| getHashCode() X-Ref |
| Get hash code. return: string Hash code |
| setLowercaseCallback($matches) X-Ref |
| No description |
| escapeQuotesCallback($matches) X-Ref |
| No description |
| formatAsDate(&$value, &$format) X-Ref |
| No description |
| formatAsPercentage(&$value, &$format) X-Ref |
| No description |
| formatAsFraction(&$value, &$format) X-Ref |
| No description |
| mergeComplexNumberFormatMasks($numbers, $masks) X-Ref |
| No description |
| processComplexNumberFormatMask($number, $mask) X-Ref |
| No description |
| complexNumberFormatMask($number, $mask, $splitOnPoint = true) X-Ref |
| No description |
| formatStraightNumericValue($value, $format, array $matches, $useThousands, $number_regex) X-Ref |
| No description |
| formatAsNumber($value, $format) X-Ref |
| No description |
| splitFormatCompare($value, $cond, $val, $dfcond, $dfval) X-Ref |
| No description |
| splitFormat($sections, $value) X-Ref |
| No description |
| 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 |
