Documentation

NumberFormat extends Supervisor

in package

• Application

Table of Contents

Constants

DATE_TIME_INDEX  = 22

DATE_TIME_OR_DATETIME_ARRAY  = [self::FORMAT_DATE_YYYYMMDD, self::FORMAT_DATE_DDMMYYYY, self::FORMAT_DATE_DMYSLASH, self::FORMAT_DATE_DMYMINUS, self::FORMAT_DATE_DMMINUS, self::FORMAT_DATE_MYMINUS, self::FORMAT_DATE_XLSX14, self::FORMAT_DATE_XLSX14_ACTUAL, self::FORMAT_DATE_XLSX15, self::FORMAT_DATE_XLSX16, self::FORMAT_DATE_XLSX17, self::FORMAT_DATE_XLSX22, self::FORMAT_DATE_XLSX22_ACTUAL, self::FORMAT_DATE_DATETIME, self::FORMAT_DATE_TIME1, self::FORMAT_DATE_TIME2, self::FORMAT_DATE_TIME3, self::FORMAT_DATE_TIME4, self::FORMAT_DATE_TIME5, self::FORMAT_DATE_TIME6, self::FORMAT_DATE_TIME7, self::FORMAT_DATE_TIME8, self::FORMAT_DATE_YYYYMMDDSLASH, self::FORMAT_DATE_LONG_DATE]

FORMAT_ACCOUNTING_EUR  = '_("€"* #,##0.00_);_("€"* \(#,##0.00\);_("€"* "-"??_);_(@_)'

FORMAT_ACCOUNTING_USD  = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)'

FORMAT_CURRENCY_EUR  = '#,##0.00_-[$€]'

FORMAT_CURRENCY_EUR_INTEGER  = '#,##0_-[$€]'

FORMAT_CURRENCY_USD  = '$#,##0.00_-'

FORMAT_CURRENCY_USD_INTEGER  = '$#,##0_-'

FORMAT_DATE_DATETIME  = 'd/m/yy h:mm'

FORMAT_DATE_DDMMYYYY  = 'dd/mm/yyyy'

FORMAT_DATE_DMMINUS  = 'd-m'

FORMAT_DATE_DMYMINUS  = 'd-m-yy'

FORMAT_DATE_DMYSLASH  = 'd/m/yy'

FORMAT_DATE_LONG_DATE  = 'dddd, mmmm d, yyyy'

FORMAT_DATE_MYMINUS  = 'm-yy'

FORMAT_DATE_TIME1  = 'h:mm AM/PM'

FORMAT_DATE_TIME2  = 'h:mm:ss AM/PM'

FORMAT_DATE_TIME3  = 'h:mm'

FORMAT_DATE_TIME4  = 'h:mm:ss'

FORMAT_DATE_TIME5  = 'mm:ss'

FORMAT_DATE_TIME6  = 'h:mm:ss'

FORMAT_DATE_TIME7  = 'i:s.S'

FORMAT_DATE_TIME8  = 'h:mm:ss;@'

FORMAT_DATE_XLSX14  = 'mm-dd-yy'

FORMAT_DATE_XLSX14_ACTUAL  = 'm/d/yyyy'

FORMAT_DATE_XLSX15  = 'd-mmm-yy'

FORMAT_DATE_XLSX16  = 'd-mmm'

FORMAT_DATE_XLSX17  = 'mmm-yy'

FORMAT_DATE_XLSX22  = 'm/d/yy h:mm'

FORMAT_DATE_XLSX22_ACTUAL  = 'm/d/yyyy h:mm'

FORMAT_DATE_YYYYMMDD  = 'yyyy-mm-dd'

FORMAT_DATE_YYYYMMDDSLASH  = 'yyyy/mm/dd;@'

FORMAT_GENERAL  = 'General'

FORMAT_NUMBER  = '0'

FORMAT_NUMBER_0  = '0.0'

FORMAT_NUMBER_00  = '0.00'

FORMAT_NUMBER_COMMA_SEPARATED1  = '#,##0.00'

FORMAT_NUMBER_COMMA_SEPARATED2  = '#,##0.00_-'

FORMAT_PERCENTAGE  = '0%'

FORMAT_PERCENTAGE_0  = '0.0%'

FORMAT_PERCENTAGE_00  = '0.00%'

FORMAT_SYSDATE_F800  = '[$-F800]'

FORMAT_SYSDATE_X  = '[$-x-sysdate]'

FORMAT_SYSTIME_F400  = '[$-F400]'

FORMAT_SYSTIME_X  = '[$-x-systime]'

FORMAT_TEXT  = '@'

SHORT_DATE_INDEX  = 14

TIME_OR_DATETIME_ARRAY  = [self::FORMAT_DATE_XLSX22, self::FORMAT_DATE_DATETIME, self::FORMAT_DATE_TIME1, self::FORMAT_DATE_TIME2, self::FORMAT_DATE_TIME3, self::FORMAT_DATE_TIME4, self::FORMAT_DATE_TIME5, self::FORMAT_DATE_TIME6, self::FORMAT_DATE_TIME7, self::FORMAT_DATE_TIME8]

Properties

$builtInFormatCode  : false|int

Built-in format Code.

$builtInFormats  : array<string|int, mixed>

Excel built-in number formats.

$dateTimeFormat  : string

$flippedBuiltInFormats  : array<string|int, mixed>

Excel built-in number formats (flipped, for faster lookups).

$formatCode  : string|null

Format Code.

$isSupervisor  : bool

Supervisor?

$longDateFormat  : string

$parent  : Spreadsheet|Supervisor

Parent. Only used for supervisor.

$parentPropertyName  : string|null

Parent property name.

$shortDateFormat  : string

$timeFormat  : string

Methods

__clone()  : mixed

Implement PHP __clone to create a deep clone, not just a shallow copy.

__construct()  : mixed

Create a new NumberFormat.

applyFromArray()  : $this

Apply styles from array.

bindParent()  : $this

Bind parent. Only used for supervisor.

builtInFormatCode()  : string

Get built-in format code.

builtInFormatCodeIndex()  : false|int

Get built-in format code index.

convertSystemFormats()  : string|null

exportArray()  : array<string|int, mixed>

Export style as array.

getActiveCell()  : string

Get the currently active cell coordinate in currently active sheet.

getActiveSheet()  : Worksheet

Get the currently active sheet. Only used for supervisor.

getBuiltInFormatCode()  : false|int

Get Built-In Format Code.

getDateTimeFormat()  : string

getFormatCode()  : string|null

Get Format Code.

getHashCode()  : string

Get hash code.

getIsSupervisor()  : bool

Is this a supervisor or a cell style component?

getLongDateFormat()  : string

getSelectedCells()  : string

Get the currently active cell coordinate in currently active sheet.

getSharedComponent()  : self

Get the shared style component for the currently active cell in currently active sheet.

getShortDateFormat()  : string

getStyleArray()  : array<string|int, mixed>

Build style array from subcomponents.

getTimeFormat()  : string

setBuiltInFormatCode()  : $this

Set Built-In Format Code.

setDateTimeFormat()  : void

setFormatCode()  : $this

Set Format Code.

setLongDateFormat()  : void

setShortDateFormat()  : void

setTimeFormat()  : void

toFormattedString()  : string

Convert a value in a pre-defined format to a PHP string.

exportArray1()  : array<string|int, mixed>

Abstract method to be implemented in anything which extends this class.

exportArray2()  : void

Populate array from exportArray1.

fillBuiltInFormatCodes()  : void

Fill built-in format codes.