Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\NumberFormat:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\NumberFormat:

Public Member Functions
	__construct ($isSupervisor=false, $isConditional=false)
	Create a new NumberFormat. More...

	getSharedComponent ()
	Get the shared style component for the currently active cell in currently active sheet. More...

	getStyleArray ($array)
	Build style array from subcomponents. More...

	applyFromArray (array $pStyles)
	Apply styles from array. More...

	getFormatCode ()
	Get Format Code. More...

	setFormatCode ($pValue)
	Set Format Code. More...

	getBuiltInFormatCode ()
	Get Built-In Format Code. More...

	setBuiltInFormatCode ($pValue)
	Set Built-In Format Code. More...

	getHashCode ()
	Get hash code. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	__construct ($isSupervisor=false)
	Create a new Supervisor. More...

	bindParent ($parent, $parentPropertyName=null)
	Bind parent. More...

	getIsSupervisor ()
	Is this a supervisor or a cell style component? More...

	getActiveSheet ()
	Get the currently active sheet. More...

	getSelectedCells ()
	Get the currently active cell coordinate in currently active sheet. More...

	getActiveCell ()
	Get the currently active cell coordinate in currently active sheet. More...

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

	exportArray ()
	Export style as array. More...

Static Public Member Functions
static	builtInFormatCode ($pIndex)
	Get built-in format code. More...

static	builtInFormatCodeIndex ($formatCode)
	Get built-in format code index. More...

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

Data Fields
const	FORMAT_GENERAL = 'General'

const	FORMAT_TEXT = '@'

const	FORMAT_NUMBER = '0'

const	FORMAT_NUMBER_00 = '0.00'

const	FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00'

const	FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-'

const	FORMAT_PERCENTAGE = '0%'

const	FORMAT_PERCENTAGE_00 = '0.00%'

const	FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd'

const	FORMAT_DATE_YYYYMMDD = 'yyyy-mm-dd'

const	FORMAT_DATE_DDMMYYYY = 'dd/mm/yyyy'

const	FORMAT_DATE_DMYSLASH = 'd/m/yy'

const	FORMAT_DATE_DMYMINUS = 'd-m-yy'

const	FORMAT_DATE_DMMINUS = 'd-m'

const	FORMAT_DATE_MYMINUS = 'm-yy'

const	FORMAT_DATE_XLSX14 = 'mm-dd-yy'

const	FORMAT_DATE_XLSX15 = 'd-mmm-yy'

const	FORMAT_DATE_XLSX16 = 'd-mmm'

const	FORMAT_DATE_XLSX17 = 'mmm-yy'

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

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

const	FORMAT_DATE_TIME1 = 'h:mm AM/PM'

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

const	FORMAT_DATE_TIME3 = 'h:mm'

const	FORMAT_DATE_TIME4 = 'h:mm:ss'

const	FORMAT_DATE_TIME5 = 'mm:ss'

const	FORMAT_DATE_TIME6 = 'h:mm:ss'

const	FORMAT_DATE_TIME7 = 'i:s.S'

const	FORMAT_DATE_TIME8 = 'h:mm:ss;@'

const	FORMAT_DATE_YYYYMMDDSLASH = 'yyyy/mm/dd;@'

const	FORMAT_CURRENCY_USD_SIMPLE = '"$"#,##0.00_-'

const	FORMAT_CURRENCY_USD = '$#,##0_-'

const	FORMAT_CURRENCY_EUR_SIMPLE = '#,##0.00_-"€"'

const	FORMAT_CURRENCY_EUR = '#,##0_-"€"'

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

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

Protected Member Functions
	exportArray1 ()

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	exportArray1 ()
	Abstract method to be implemented in anything which extends this class. More...

	exportArray2 (array &$exportedArray, string $index, $objOrValue)
	Populate array from exportArray1. More...

Protected Attributes
	$formatCode = self::FORMAT_GENERAL

	$builtInFormatCode = 0

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Style\Supervisor
	$isSupervisor

	$parent

	$parentPropertyName

Static Protected Attributes
static	$builtInFormats

static	$flippedBuiltInFormats

Static Private Member Functions
static	fillBuiltInFormatCodes ()
	Fill built-in format codes. More...

Detailed Description

Definition at line 5 of file NumberFormat.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::__construct	(	$isSupervisor = `false`,
		$isConditional = `false`
	)

Create a new NumberFormat.

Parameters

bool	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
bool	$isConditional	Flag indicating if this is a conditional style or not Leave this value at default unless you understand exactly what its ramifications are

Definition at line 88 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\$isSupervisor, and PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCode().

     {
         // Supervisor?
         parent::__construct($isSupervisor);
 
         if ($isConditional) {
             $this->formatCode = null;
             $this->builtInFormatCode = false;
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ applyFromArray()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::applyFromArray ( array $pStyles )

Apply styles from array.

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

Parameters

array $pStyles Array containing style information

Returns: $this

Definition at line 137 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\getStyleArray(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\setFormatCode().

     {
         if ($this->isSupervisor) {
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
         } else {
             if (isset($pStyles['formatCode'])) {
                 $this->setFormatCode($pStyles['formatCode']);
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ builtInFormatCode()

static PhpOffice\PhpSpreadsheet\Style\NumberFormat::builtInFormatCode ( $pIndex )

static

Get built-in format code.

Parameters

int $pIndex

Returns: string

Definition at line 334 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\__construct(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\getFormatCode(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\getHashCode(), PhpOffice\PhpSpreadsheet\Reader\Xls\readXf(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\setBuiltInFormatCode(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\setFormatCode().

     {
         // Clean parameter
         $pIndex = (int) $pIndex;
 
         // Ensure built-in format codes are available
         self::fillBuiltInFormatCodes();
 
         // Lookup format code
         if (isset(self::$builtInFormats[$pIndex])) {
             return self::$builtInFormats[$pIndex];
         }
 
         return '';
     }

Here is the caller graph for this function:

◆ builtInFormatCodeIndex()

static PhpOffice\PhpSpreadsheet\Style\NumberFormat::builtInFormatCodeIndex ( $formatCode )

static

Get built-in format code index.

Parameters

string $formatCode

Returns: bool|int

Definition at line 357 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\NumberFormat\$formatCode.

     {
         // Ensure built-in format codes are available
         self::fillBuiltInFormatCodes();
 
         // Lookup format code
         if (array_key_exists($formatCode, self::$flippedBuiltInFormats)) {
             return self::$flippedBuiltInFormats[$formatCode];
         }
 
         return false;
     }

◆ exportArray1()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::exportArray1 ( )

protected

Definition at line 402 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\Supervisor\exportArray2(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getFormatCode().

                                      : array
     {
         $exportedArray = [];
         $this->exportArray2($exportedArray, 'formatCode', $this->getFormatCode());
 
         return $exportedArray;
     }

Here is the call graph for this function:

◆ fillBuiltInFormatCodes()

static PhpOffice\PhpSpreadsheet\Style\NumberFormat::fillBuiltInFormatCodes ( )

staticprivate

Fill built-in format codes.

Definition at line 227 of file NumberFormat.php.

                                                     : void
     {
         //  [MS-OI29500: Microsoft Office Implementation Information for ISO/IEC-29500 Standard Compliance]
         //  18.8.30. numFmt (Number Format)
         //
         //  The ECMA standard defines built-in format IDs
         //      14: "mm-dd-yy"
         //      22: "m/d/yy h:mm"
         //      37: "#,##0 ;(#,##0)"
         //      38: "#,##0 ;[Red](#,##0)"
         //      39: "#,##0.00;(#,##0.00)"
         //      40: "#,##0.00;[Red](#,##0.00)"
         //      47: "mmss.0"
         //      KOR fmt 55: "yyyy-mm-dd"
         //  Excel defines built-in format IDs
         //      14: "m/d/yyyy"
         //      22: "m/d/yyyy h:mm"
         //      37: "#,##0_);(#,##0)"
         //      38: "#,##0_);[Red](#,##0)"
         //      39: "#,##0.00_);(#,##0.00)"
         //      40: "#,##0.00_);[Red](#,##0.00)"
         //      47: "mm:ss.0"
         //      KOR fmt 55: "yyyy/mm/dd"
 
         // Built-in format codes
         if (self::$builtInFormats === null) {
             self::$builtInFormats = [];
 
             // General
             self::$builtInFormats[0] = self::FORMAT_GENERAL;
             self::$builtInFormats[1] = '0';
             self::$builtInFormats[2] = '0.00';
             self::$builtInFormats[3] = '#,##0';
             self::$builtInFormats[4] = '#,##0.00';
 
             self::$builtInFormats[9] = '0%';
             self::$builtInFormats[10] = '0.00%';
             self::$builtInFormats[11] = '0.00E+00';
             self::$builtInFormats[12] = '# ?/?';
             self::$builtInFormats[13] = '# ??/??';
             self::$builtInFormats[14] = 'm/d/yyyy'; // Despite ECMA 'mm-dd-yy';
             self::$builtInFormats[15] = 'd-mmm-yy';
             self::$builtInFormats[16] = 'd-mmm';
             self::$builtInFormats[17] = 'mmm-yy';
             self::$builtInFormats[18] = 'h:mm AM/PM';
             self::$builtInFormats[19] = 'h:mm:ss AM/PM';
             self::$builtInFormats[20] = 'h:mm';
             self::$builtInFormats[21] = 'h:mm:ss';
             self::$builtInFormats[22] = 'm/d/yyyy h:mm'; // Despite ECMA 'm/d/yy h:mm';
 
             self::$builtInFormats[37] = '#,##0_);(#,##0)'; //  Despite ECMA '#,##0 ;(#,##0)';
             self::$builtInFormats[38] = '#,##0_);[Red](#,##0)'; //  Despite ECMA '#,##0 ;[Red](#,##0)';
             self::$builtInFormats[39] = '#,##0.00_);(#,##0.00)'; //  Despite ECMA '#,##0.00;(#,##0.00)';
             self::$builtInFormats[40] = '#,##0.00_);[Red](#,##0.00)'; //  Despite ECMA '#,##0.00;[Red](#,##0.00)';
 
             self::$builtInFormats[44] = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)';
             self::$builtInFormats[45] = 'mm:ss';
             self::$builtInFormats[46] = '[h]:mm:ss';
             self::$builtInFormats[47] = 'mm:ss.0'; //  Despite ECMA 'mmss.0';
             self::$builtInFormats[48] = '##0.0E+0';
             self::$builtInFormats[49] = '@';
 
             // CHT
             self::$builtInFormats[27] = '[$-404]e/m/d';
             self::$builtInFormats[30] = 'm/d/yy';
             self::$builtInFormats[36] = '[$-404]e/m/d';
             self::$builtInFormats[50] = '[$-404]e/m/d';
             self::$builtInFormats[57] = '[$-404]e/m/d';
 
             // THA
             self::$builtInFormats[59] = 't0';
             self::$builtInFormats[60] = 't0.00';
             self::$builtInFormats[61] = 't#,##0';
             self::$builtInFormats[62] = 't#,##0.00';
             self::$builtInFormats[67] = 't0%';
             self::$builtInFormats[68] = 't0.00%';
             self::$builtInFormats[69] = 't# ?/?';
             self::$builtInFormats[70] = 't# ??/??';
 
             // JPN
             self::$builtInFormats[28] = '[$-411]ggge"年"m"月"d"日"';
             self::$builtInFormats[29] = '[$-411]ggge"年"m"月"d"日"';
             self::$builtInFormats[31] = 'yyyy"年"m"月"d"日"';
             self::$builtInFormats[32] = 'h"時"mm"分"';
             self::$builtInFormats[33] = 'h"時"mm"分"ss"秒"';
             self::$builtInFormats[34] = 'yyyy"年"m"月"';
             self::$builtInFormats[35] = 'm"月"d"日"';
             self::$builtInFormats[51] = '[$-411]ggge"年"m"月"d"日"';
             self::$builtInFormats[52] = 'yyyy"年"m"月"';
             self::$builtInFormats[53] = 'm"月"d"日"';
             self::$builtInFormats[54] = '[$-411]ggge"年"m"月"d"日"';
             self::$builtInFormats[55] = 'yyyy"年"m"月"';
             self::$builtInFormats[56] = 'm"月"d"日"';
             self::$builtInFormats[58] = '[$-411]ggge"年"m"月"d"日"';
 
             // Flip array (for faster lookups)
             self::$flippedBuiltInFormats = array_flip(self::$builtInFormats);
         }
     }

◆ getBuiltInFormatCode()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::getBuiltInFormatCode ( )

Get Built-In Format Code.

Returns: false|int

Definition at line 195 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\NumberFormat\$builtInFormatCode, and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getSharedComponent().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getBuiltInFormatCode();
         }
 
         return $this->builtInFormatCode;
     }

Here is the call graph for this function:

◆ getFormatCode()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::getFormatCode ( )

Get Format Code.

Returns: null|string

Definition at line 155 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\NumberFormat\$formatCode, PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCode(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getSharedComponent().

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\exportArray1(), PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormat(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Style\writeNumFmt().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getFormatCode();
         }
         if ($this->builtInFormatCode !== false) {
             return self::builtInFormatCode($this->builtInFormatCode);
         }
 
         return $this->formatCode;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 375 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCode(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getSharedComponent().

     {
         if ($this->isSupervisor) {
             return $this->getSharedComponent()->getHashCode();
         }
 
         return md5(
             $this->formatCode .
             $this->builtInFormatCode .
             __CLASS__
         );
     }

Here is the call graph for this function:

◆ getSharedComponent()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::getSharedComponent ( )

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

Only used for style supervisor.

Returns: NumberFormat

Definition at line 105 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\getBuiltInFormatCode(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\getFormatCode(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getHashCode().

     {
         return $this->parent->getSharedComponent()->getNumberFormat();
     }

Here is the caller graph for this function:

◆ getStyleArray()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::getStyleArray ( $array )

Build style array from subcomponents.

Parameters

array $array

Returns: array

Definition at line 117 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\applyFromArray(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\setBuiltInFormatCode(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\setFormatCode().

     {
         return ['numberFormat' => $array];
     }

Here is the caller graph for this function:

◆ setBuiltInFormatCode()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::setBuiltInFormatCode ( $pValue )

Set Built-In Format Code.

Parameters

int $pValue

Returns: $this

Definition at line 211 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCode(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getStyleArray().

     {
         if ($this->isSupervisor) {
             $styleArray = $this->getStyleArray(['formatCode' => self::builtInFormatCode($pValue)]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->builtInFormatCode = $pValue;
             $this->formatCode = self::builtInFormatCode($pValue);
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ setFormatCode()

PhpOffice\PhpSpreadsheet\Style\NumberFormat::setFormatCode ( $pValue )

Set Format Code.

Parameters

string $pValue see self::FORMAT_*

Returns: $this

Definition at line 174 of file NumberFormat.php.

References PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCode(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getActiveSheet(), PhpOffice\PhpSpreadsheet\Style\Supervisor\getSelectedCells(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getStyleArray().

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\applyFromArray(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readNumberFormat().

     {
         if ($pValue == '') {
             $pValue = self::FORMAT_GENERAL;
         }
         if ($this->isSupervisor) {
             $styleArray = $this->getStyleArray(['formatCode' => $pValue]);
             $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
         } else {
             $this->formatCode = $pValue;
             $this->builtInFormatCode = self::builtInFormatCodeIndex($pValue);
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toFormattedString()

static PhpOffice\PhpSpreadsheet\Style\NumberFormat::toFormattedString	(	$value,
		$format,
		$callBack = `null`
	)

static

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

Parameters

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

Returns: string Formatted string

Definition at line 397 of file NumberFormat.php.

References $format, and PhpOffice\PhpSpreadsheet\Style\NumberFormat\Formatter\toFormattedString().

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\calculateColumnWidths(), PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\DOLLAR(), PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph\formatDataSetLabels(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellDataValue(), PhpOffice\PhpSpreadsheet\Cell\Cell\getFormattedValue(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\rangeToArray(), and PhpOffice\PhpSpreadsheet\Calculation\TextData\Format\TEXTFORMAT().

     {
         return NumberFormat\Formatter::toFormattedString($value, $format, $callBack);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $builtInFormatCode

PhpOffice\PhpSpreadsheet\Style\NumberFormat::$builtInFormatCode = 0

protected

Definition at line 76 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\getBuiltInFormatCode().

◆ $builtInFormats

PhpOffice\PhpSpreadsheet\Style\NumberFormat::$builtInFormats

staticprotected

Definition at line 55 of file NumberFormat.php.

◆ $flippedBuiltInFormats

PhpOffice\PhpSpreadsheet\Style\NumberFormat::$flippedBuiltInFormats

staticprotected

Definition at line 62 of file NumberFormat.php.

◆ $formatCode

PhpOffice\PhpSpreadsheet\Style\NumberFormat::$formatCode = self::FORMAT_GENERAL

protected

Definition at line 69 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCodeIndex(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\getFormatCode().

◆ FORMAT_ACCOUNTING_EUR

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_ACCOUNTING_EUR = '_("€"* #,##0.00_);_("€"* $#,##0.00$;_("€"* "-"??_);_(@_)'

Definition at line 48 of file NumberFormat.php.

◆ FORMAT_ACCOUNTING_USD

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_ACCOUNTING_USD = '_("$"* #,##0.00_);_("$"* $#,##0.00$;_("$"* "-"??_);_(@_)'

Definition at line 47 of file NumberFormat.php.

◆ FORMAT_CURRENCY_EUR

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_CURRENCY_EUR = '#,##0_-"€"'

Definition at line 46 of file NumberFormat.php.

◆ FORMAT_CURRENCY_EUR_SIMPLE

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE = '#,##0.00_-"€"'

Definition at line 45 of file NumberFormat.php.

◆ FORMAT_CURRENCY_USD

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_CURRENCY_USD = '$#,##0_-'

Definition at line 44 of file NumberFormat.php.

◆ FORMAT_CURRENCY_USD_SIMPLE

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_CURRENCY_USD_SIMPLE = '"$"#,##0.00_-'

Definition at line 43 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\bindValue(), and PhpOffice\PhpSpreadsheet\Reader\Ods\load().

◆ FORMAT_DATE_DATETIME

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DATETIME = 'd/m/yy h:mm'

Definition at line 32 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_DDMMYYYY

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DDMMYYYY = 'dd/mm/yyyy'

Definition at line 22 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_DMMINUS

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DMMINUS = 'd-m'

Definition at line 25 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_DMYMINUS

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DMYMINUS = 'd-m-yy'

Definition at line 24 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_DMYSLASH

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_DMYSLASH = 'd/m/yy'

Definition at line 23 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_MYMINUS

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_MYMINUS = 'm-yy'

Definition at line 26 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_TIME1

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME1 = 'h:mm AM/PM'

Definition at line 33 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_TIME2

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM'

Definition at line 34 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_TIME3

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME3 = 'h:mm'

Definition at line 35 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode(), and PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\setTimeHoursMinutes().

◆ FORMAT_DATE_TIME4

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME4 = 'h:mm:ss'

Definition at line 36 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode(), PhpOffice\PhpSpreadsheet\Reader\Ods\load(), and PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\setTimeHoursMinutesSeconds().

◆ FORMAT_DATE_TIME5

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME5 = 'mm:ss'

Definition at line 37 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_TIME6

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME6 = 'h:mm:ss'

Definition at line 38 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_TIME7

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME7 = 'i:s.S'

Definition at line 39 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_TIME8

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_TIME8 = 'h:mm:ss;@'

Definition at line 40 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_XLSX14

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_XLSX14 = 'mm-dd-yy'

Definition at line 27 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_XLSX15

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_XLSX15 = 'd-mmm-yy'

Definition at line 28 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode(), and PhpOffice\PhpSpreadsheet\Reader\Ods\load().

◆ FORMAT_DATE_XLSX16

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_XLSX16 = 'd-mmm'

Definition at line 29 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_XLSX17

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_XLSX17 = 'mmm-yy'

Definition at line 30 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_XLSX22

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_XLSX22 = 'm/d/yy h:mm'

Definition at line 31 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_YYYYMMDD

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_YYYYMMDD = 'yyyy-mm-dd'

Definition at line 21 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_YYYYMMDD2

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd'

Definition at line 20 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_DATE_YYYYMMDDSLASH

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_YYYYMMDDSLASH = 'yyyy/mm/dd;@'

Definition at line 41 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode().

◆ FORMAT_GENERAL

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_GENERAL = 'General'

Definition at line 8 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\NumberFormatter\format(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), PhpOffice\PhpSpreadsheet\Shared\Date\isDateTimeFormatCode(), PhpOffice\PhpSpreadsheet\Reader\Ods\load(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\rangeToArray(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\Formatter\toFormattedString().

◆ FORMAT_NUMBER

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER = '0'

Definition at line 12 of file NumberFormat.php.

◆ FORMAT_NUMBER_00

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER_00 = '0.00'

Definition at line 13 of file NumberFormat.php.

◆ FORMAT_NUMBER_COMMA_SEPARATED1

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00'

Definition at line 14 of file NumberFormat.php.

◆ FORMAT_NUMBER_COMMA_SEPARATED2

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-'

Definition at line 15 of file NumberFormat.php.

◆ FORMAT_PERCENTAGE

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_PERCENTAGE = '0%'

Definition at line 17 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\PercentageFormatter\format().

◆ FORMAT_PERCENTAGE_00

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_PERCENTAGE_00 = '0.00%'

Definition at line 18 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Ods\load(), and PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder\setPercentage().

◆ FORMAT_TEXT

const PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_TEXT = '@'

Definition at line 10 of file NumberFormat.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\NumberFormat\Formatter\toFormattedString().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/NumberFormat.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFromArray()

◆ builtInFormatCode()

◆ builtInFormatCodeIndex()

◆ exportArray1()

◆ fillBuiltInFormatCodes()

◆ getBuiltInFormatCode()

◆ getFormatCode()

◆ getHashCode()

◆ getSharedComponent()

◆ getStyleArray()

◆ setBuiltInFormatCode()

◆ setFormatCode()

◆ toFormattedString()

Field Documentation

◆ $builtInFormatCode

◆ $builtInFormats

◆ $flippedBuiltInFormats

◆ $formatCode

◆ FORMAT_ACCOUNTING_EUR

◆ FORMAT_ACCOUNTING_USD

◆ FORMAT_CURRENCY_EUR

◆ FORMAT_CURRENCY_EUR_SIMPLE

◆ FORMAT_CURRENCY_USD

◆ FORMAT_CURRENCY_USD_SIMPLE

◆ FORMAT_DATE_DATETIME

◆ FORMAT_DATE_DDMMYYYY

◆ FORMAT_DATE_DMMINUS

◆ FORMAT_DATE_DMYMINUS

◆ FORMAT_DATE_DMYSLASH

◆ FORMAT_DATE_MYMINUS

◆ FORMAT_DATE_TIME1

◆ FORMAT_DATE_TIME2

◆ FORMAT_DATE_TIME3

◆ FORMAT_DATE_TIME4

◆ FORMAT_DATE_TIME5

◆ FORMAT_DATE_TIME6

◆ FORMAT_DATE_TIME7

◆ FORMAT_DATE_TIME8

◆ FORMAT_DATE_XLSX14

◆ FORMAT_DATE_XLSX15

◆ FORMAT_DATE_XLSX16

◆ FORMAT_DATE_XLSX17

◆ FORMAT_DATE_XLSX22

◆ FORMAT_DATE_YYYYMMDD

◆ FORMAT_DATE_YYYYMMDD2

◆ FORMAT_DATE_YYYYMMDDSLASH

◆ FORMAT_GENERAL

◆ FORMAT_NUMBER

◆ FORMAT_NUMBER_00

◆ FORMAT_NUMBER_COMMA_SEPARATED1

◆ FORMAT_NUMBER_COMMA_SEPARATED2

◆ FORMAT_PERCENTAGE

◆ FORMAT_PERCENTAGE_00

◆ FORMAT_TEXT