PHPExcel_Style_NumberFormat Class Reference

Inheritance diagram for PHPExcel_Style_NumberFormat:

Collaboration diagram for PHPExcel_Style_NumberFormat:

Public Member Functions
	__construct ($isSupervisor=FALSE, $isConditional=FALSE)
	Create a new PHPExcel_Style_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 ($pStyles=null)
	Apply styles from array. More...
	getFormatCode ()
	Get Format Code. More...
	setFormatCode ($pValue=PHPExcel_Style_NumberFormat::FORMAT_GENERAL)
	Set Format Code. More...
	getBuiltInFormatCode ()
	Get Built-In Format Code. More...
	setBuiltInFormatCode ($pValue=0)
	Set Built-In Format Code. More...
	getHashCode ()
	Get hash code. More...
Public Member Functions inherited from PHPExcel_Style_Supervisor
	__construct ($isSupervisor=FALSE)
	Create a new PHPExcel_Style_Alignment. 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...
	getHashCode ()
	Get hash code. 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='0', $format=PHPExcel_Style_NumberFormat::FORMAT_GENERAL, $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 = 'yy-mm-dd'
const	FORMAT_DATE_DDMMYYYY = 'dd/mm/yy'
const	FORMAT_DATE_DMYSLASH = 'd/m/y'
const	FORMAT_DATE_DMYMINUS = 'd-m-y'
const	FORMAT_DATE_DMMINUS = 'd-m'
const	FORMAT_DATE_MYMINUS = 'm-y'
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/y 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 = 'yy/mm/dd;@'
const	FORMAT_CURRENCY_USD_SIMPLE = '"$"#,##0.00_-'
const	FORMAT_CURRENCY_USD = '$#,##0_-'
const	FORMAT_CURRENCY_EUR_SIMPLE = '[$EUR ]#,##0.00_-'

Protected Attributes
	$_formatCode = PHPExcel_Style_NumberFormat::FORMAT_GENERAL
	$_builtInFormatCode = 0
Protected Attributes inherited from PHPExcel_Style_Supervisor
	$_isSupervisor
	$_parent

Static Protected Attributes
static	$_builtInFormats
static	$_flippedBuiltInFormats

Static Private Member Functions
static	fillBuiltInFormatCodes ()
	Fill built-in format codes. More...
static	_formatAsDate (&$value, &$format)
static	_formatAsPercentage (&$value, &$format)
static	_formatAsFraction (&$value, &$format)
static	_complexNumberFormatMask ($number, $mask, $level=0)

Static Private Attributes
static	$_dateFormatReplacements
static	$_dateFormatReplacements24
static	$_dateFormatReplacements12

Detailed Description

Definition at line 36 of file NumberFormat.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Style_NumberFormat::__construct	(		$isSupervisor = FALSE,
			$isConditional = FALSE
	)

Create a new PHPExcel_Style_NumberFormat.

Parameters

boolean	$isSupervisor	Flag indicating if this is a supervisor or not Leave this value at default unless you understand exactly what its ramifications are
boolean	$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 116 of file NumberFormat.php.

        {
                // Supervisor?
                parent::__construct($isSupervisor);
 
                if ($isConditional) {
                        $this->_formatCode = NULL;
                        $this->_builtInFormatCode = FALSE;
                }
        }

Member Function Documentation

_complexNumberFormatMask()

static PHPExcel_Style_NumberFormat::_complexNumberFormatMask (   $number,   $mask,   $level = 0  )

staticprivate

Definition at line 501 of file NumberFormat.php.

                                                                                     {
        $sign = ($number < 0.0);
        $number = abs($number);
                if (strpos($mask,'.') !== false) {
                        $numbers = explode('.', $number . '.0');
                        $masks = explode('.', $mask . '.0');
                        $result1 = self::_complexNumberFormatMask($numbers[0], $masks[0], 1);
                        $result2 = strrev(self::_complexNumberFormatMask(strrev($numbers[1]), strrev($masks[1]), 1));
                        return (($sign) ? '-' : '') . $result1 . '.' . $result2;
                }
 
                $r = preg_match_all('/0+/', $mask, $result, PREG_OFFSET_CAPTURE);
                if ($r > 1) {
                        $result = array_reverse($result[0]);
 
                        foreach($result as $block) {
                                $divisor = 1 . $block[0];
                                $size = strlen($block[0]);
                                $offset = $block[1];
 
                                $blockValue = sprintf(
                                        '%0' . $size . 'd',
                                        fmod($number, $divisor)
                                );
                                $number = floor($number / $divisor);
                                $mask = substr_replace($mask, $blockValue, $offset, $size);
                        }
                        if ($number > 0) {
                                $mask = substr_replace($mask, $number, $offset, 0);
                        }
                        $result = $mask;
                } else {
                        $result = $number;
                }
 
                return (($sign) ? '-' : '') . $result;
        }

References $mask, $r, $result, $size, _complexNumberFormatMask(), and sprintf.

Referenced by _complexNumberFormatMask(), and toFormattedString().

Here is the call graph for this function:

Here is the caller graph for this function:

_formatAsDate()

static PHPExcel_Style_NumberFormat::_formatAsDate ( &  $value, &  $format  )

staticprivate

Definition at line 435 of file NumberFormat.php.

        {
                // dvc: convert Excel formats to PHP date formats
 
                // strip off first part containing e.g. [$-F800] or [$USD-409]
                // general syntax: [$<Currency string>-<language info>]
                // language info is in hexadecimal
                $format = preg_replace('/^(\[\$[A-Z]*-[0-9A-F]*\])/i', '', $format);
 
                // OpenOffice.org uses upper-case number formats, e.g. 'YYYY', convert to lower-case
                $format = strtolower($format);
 
                $format = strtr($format,self::$_dateFormatReplacements);
                if (!strpos($format,'A')) {     // 24-hour time format
                        $format = strtr($format,self::$_dateFormatReplacements24);
                } else {                                        // 12-hour time format
                        $format = strtr($format,self::$_dateFormatReplacements12);
                }
 
                $dateObj = PHPExcel_Shared_Date::ExcelToPHPObject($value);
                $value = $dateObj->format($format);
        }

References $format, and PHPExcel_Shared_Date\ExcelToPHPObject().

Referenced by toFormattedString().

Here is the call graph for this function:

Here is the caller graph for this function:

_formatAsFraction()

static PHPExcel_Style_NumberFormat::_formatAsFraction ( &  $value, &  $format  )

staticprivate

Definition at line 476 of file NumberFormat.php.

        {
                $sign = ($value < 0) ? '-' : '';
 
                $integerPart = floor(abs($value));
                $decimalPart = trim(fmod(abs($value),1),'0.');
                $decimalLength = strlen($decimalPart);
                $decimalDivisor = pow(10,$decimalLength);
 
                $GCD = PHPExcel_Calculation_MathTrig::GCD($decimalPart,$decimalDivisor);
 
                $adjustedDecimalPart = $decimalPart/$GCD;
                $adjustedDecimalDivisor = $decimalDivisor/$GCD;
 
                if ((strpos($format,'0') !== false) || (strpos($format,'#') !== false) || (substr($format,0,3) == '? ?')) {
                        if ($integerPart == 0) {
                                $integerPart = '';
                        }
                        $value = "$sign$integerPart $adjustedDecimalPart/$adjustedDecimalDivisor";
                } else {
                        $adjustedDecimalPart += $integerPart * $adjustedDecimalDivisor;
                        $value = "$sign$adjustedDecimalPart/$adjustedDecimalDivisor";
                }
        }

References $format, and PHPExcel_Calculation_MathTrig\GCD().

Referenced by toFormattedString().

Here is the call graph for this function:

Here is the caller graph for this function:

_formatAsPercentage()

static PHPExcel_Style_NumberFormat::_formatAsPercentage ( &  $value, &  $format  )

staticprivate

Definition at line 458 of file NumberFormat.php.

        {
                if ($format === self::FORMAT_PERCENTAGE) {
                        $value = round( (100 * $value), 0) . '%';
                } else {
                        if (preg_match('/\.[#0]+/i', $format, $m)) {
                                $s = substr($m[0], 0, 1) . (strlen($m[0]) - 1);
                                $format = str_replace($m[0], $s, $format);
                        }
                        if (preg_match('/^[#0]+/', $format, $m)) {
                                $format = str_replace($m[0], strlen($m[0]), $format);
                        }
                        $format = '%' . str_replace('%', 'f%%', $format);
 
                        $value = sprintf($format, 100 * $value);
                }
        }

References $format, $m, $s, and sprintf.

Referenced by toFormattedString().

Here is the caller graph for this function:

applyFromArray()

PHPExcel_Style_NumberFormat::applyFromArray

(

$pStyles = null

)

Apply styles from array.

$objPHPExcel->getActiveSheet()->getStyle('B2')->getNumberFormat()->applyFromArray( array( 'code' => PHPExcel_Style_NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE ) );

Parameters

array

$pStyles

Array containing style information

Exceptions

PHPExcel_Exception

Returns

PHPExcel_Style_NumberFormat

Definition at line 164 of file NumberFormat.php.

        {
                if (is_array($pStyles)) {
                        if ($this->_isSupervisor) {
                                $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
                        } else {
                                if (array_key_exists('code', $pStyles)) {
                                        $this->setFormatCode($pStyles['code']);
                                }
                        }
                } else {
                        throw new PHPExcel_Exception("Invalid style array passed.");
                }
                return $this;
        }

References PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), getStyleArray(), and setFormatCode().

Here is the call graph for this function:

builtInFormatCode()

static PHPExcel_Style_NumberFormat::builtInFormatCode (   $pIndex )

static

Get built-in format code.

Parameters

int

$pIndex

Returns

string

Definition at line 321 of file NumberFormat.php.

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

References fillBuiltInFormatCodes().

Referenced by PHPExcel_Reader_Excel5\_readXf(), getFormatCode(), PHPExcel_Reader_Excel2007\load(), and setBuiltInFormatCode().

Here is the call graph for this function:

Here is the caller graph for this function:

builtInFormatCodeIndex()

static PHPExcel_Style_NumberFormat::builtInFormatCodeIndex (   $formatCode )

static

Get built-in format code index.

Parameters

string

$formatCode

Returns

int|boolean

Definition at line 343 of file NumberFormat.php.

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

References fillBuiltInFormatCodes().

Referenced by setFormatCode().

Here is the call graph for this function:

Here is the caller graph for this function:

fillBuiltInFormatCodes()

static PHPExcel_Style_NumberFormat::fillBuiltInFormatCodes ( )

staticprivate

Fill built-in format codes.

Definition at line 253 of file NumberFormat.php.

        {
                // Built-in format codes
                if (is_null(self::$_builtInFormats)) {
                        self::$_builtInFormats = array();
 
                        // General
                        self::$_builtInFormats[0] = PHPExcel_Style_NumberFormat::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] = '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/yy h:mm';
 
                        self::$_builtInFormats[37] = '#,##0 ;(#,##0)';
                        self::$_builtInFormats[38] = '#,##0 ;[Red](#,##0)';
                        self::$_builtInFormats[39] = '#,##0.00;(#,##0.00)';
                        self::$_builtInFormats[40] = '#,##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] = '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# ??/??';
 
                        // Flip array (for faster lookups)
                        self::$_flippedBuiltInFormats = array_flip(self::$_builtInFormats);
                }
        }

References FORMAT_GENERAL.

Referenced by builtInFormatCode(), and builtInFormatCodeIndex().

Here is the caller graph for this function:

getBuiltInFormatCode()

PHPExcel_Style_NumberFormat::getBuiltInFormatCode

(

)

Get Built-In Format Code.

Returns

int

Definition at line 223 of file NumberFormat.php.

        {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getBuiltInFormatCode();
                }
                return $this->_builtInFormatCode;
        }

References $_builtInFormatCode, and getSharedComponent().

Here is the call graph for this function:

getFormatCode()

PHPExcel_Style_NumberFormat::getFormatCode

(

)

Get Format Code.

Returns

string

Definition at line 185 of file NumberFormat.php.

        {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getFormatCode();
                }
                if ($this->_builtInFormatCode !== false)
                {
                        return self::builtInFormatCode($this->_builtInFormatCode);
                }
                return $this->_formatCode;
        }

References $_formatCode, builtInFormatCode(), and getSharedComponent().

Referenced by PHPExcel_Shared_Date\isDateTimeFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

getHashCode()

PHPExcel_Style_NumberFormat::getHashCode

(

)

Get hash code.

Returns

string Hash code

Implements PHPExcel_IComparable.

Definition at line 361 of file NumberFormat.php.

        {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getHashCode();
                }
                return md5(
                          $this->_formatCode
                        . $this->_builtInFormatCode
                        . __CLASS__
                );
        }

References getSharedComponent().

Here is the call graph for this function:

getSharedComponent()

PHPExcel_Style_NumberFormat::getSharedComponent

(

)

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

Only used for style supervisor

Returns

PHPExcel_Style_NumberFormat

Definition at line 133 of file NumberFormat.php.

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

Referenced by getBuiltInFormatCode(), getFormatCode(), and getHashCode().

Here is the caller graph for this function:

getStyleArray()

PHPExcel_Style_NumberFormat::getStyleArray

(

$array

)

Build style array from subcomponents.

Parameters

array

$array

Returns

array

Definition at line 144 of file NumberFormat.php.

        {
                return array('numberformat' => $array);
        }

Referenced by applyFromArray(), setBuiltInFormatCode(), and setFormatCode().

Here is the caller graph for this function:

setBuiltInFormatCode()

PHPExcel_Style_NumberFormat::setBuiltInFormatCode

(

$pValue = 0

)

Set Built-In Format Code.

Parameters

int

$pValue

Returns

PHPExcel_Style_NumberFormat

Definition at line 237 of file NumberFormat.php.

        {
 
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('code' => self::builtInFormatCode($pValue)));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_builtInFormatCode = $pValue;
                        $this->_formatCode = self::builtInFormatCode($pValue);
                }
                return $this;
        }

References builtInFormatCode(), PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), and getStyleArray().

Here is the call graph for this function:

setFormatCode()

PHPExcel_Style_NumberFormat::setFormatCode

(

$pValue = PHPExcel_Style_NumberFormat::FORMAT_GENERAL

)

Set Format Code.

Parameters

string

$pValue

Returns

PHPExcel_Style_NumberFormat

Definition at line 203 of file NumberFormat.php.

        {
                if ($pValue == '') {
                        $pValue = PHPExcel_Style_NumberFormat::FORMAT_GENERAL;
                }
                if ($this->_isSupervisor) {
                        $styleArray = $this->getStyleArray(array('code' => $pValue));
                        $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
                } else {
                        $this->_formatCode = $pValue;
                        $this->_builtInFormatCode = self::builtInFormatCodeIndex($pValue);
                }
                return $this;
        }

References builtInFormatCodeIndex(), FORMAT_GENERAL, PHPExcel_Style_Supervisor\getActiveSheet(), PHPExcel_Style_Supervisor\getSelectedCells(), and getStyleArray().

Referenced by applyFromArray().

Here is the call graph for this function:

Here is the caller graph for this function:

toFormattedString()

static PHPExcel_Style_NumberFormat::toFormattedString (   $value = '0',   $format = PHPExcel_Style_NumberFormat::FORMAT_GENERAL,   $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
array	$callBack	Callback function for additional formatting of string

Returns

string Formatted string

Definition at line 547 of file NumberFormat.php.

        {
                // For now we do not treat strings although section 4 of a format code affects strings
                if (!is_numeric($value)) return $value;
 
                // For 'General' format code, we just pass the value although this is not entirely the way Excel does it,
                // it seems to round numbers to a total of 10 digits.
                if (($format === PHPExcel_Style_NumberFormat::FORMAT_GENERAL) || ($format === PHPExcel_Style_NumberFormat::FORMAT_TEXT)) {
                        return $value;
                }
 
                // Get the sections, there can be up to four sections
                $sections = explode(';', $format);
 
                // Fetch the relevant section depending on whether number is positive, negative, or zero?
                // Text not supported yet.
                // Here is how the sections apply to various values in Excel:
                //   1 section:   [POSITIVE/NEGATIVE/ZERO/TEXT]
                //   2 sections:  [POSITIVE/ZERO/TEXT] [NEGATIVE]
                //   3 sections:  [POSITIVE/TEXT] [NEGATIVE] [ZERO]
                //   4 sections:  [POSITIVE] [NEGATIVE] [ZERO] [TEXT]
                switch (count($sections)) {
                        case 1:
                                $format = $sections[0];
                                break;
 
                        case 2:
                                $format = ($value >= 0) ? $sections[0] : $sections[1];
                                $value = abs($value); // Use the absolute value
                                break;
 
                        case 3:
                                $format = ($value > 0) ?
                                        $sections[0] : ( ($value < 0) ?
                                                $sections[1] : $sections[2]);
                                $value = abs($value); // Use the absolute value
                                break;
 
                        case 4:
                                $format = ($value > 0) ?
                                        $sections[0] : ( ($value < 0) ?
                                                $sections[1] : $sections[2]);
                                $value = abs($value); // Use the absolute value
                                break;
 
                        default:
                                // something is wrong, just use first section
                                $format = $sections[0];
                                break;
                }
 
                // Save format with color information for later use below
                $formatColor = $format;
 
                // Strip color information
                $color_regex = '/^\\[[a-zA-Z]+\\]/';
                $format = preg_replace($color_regex, '', $format);
 
                // Let's begin inspecting the format and converting the value to a formatted string
                if (preg_match('/^(\[\$[A-Z]*-[0-9A-F]*\])*[hmsdy]/i', $format)) { // datetime format
                        self::_formatAsDate($value, $format);
                } else if (preg_match('/%$/', $format)) { // % number format
                        self::_formatAsPercentage($value, $format);
                } else {
                        if ($format === self::FORMAT_CURRENCY_EUR_SIMPLE) {
                                $value = 'EUR ' . sprintf('%1.2f', $value);
                        } else {
                                // In Excel formats, "_" is used to add spacing, which we can't do in HTML
                                $format = preg_replace('/_./', '', $format);
 
                                // Some non-number characters are escaped with \, which we don't need
                                $format = preg_replace("/\\\\/", '', $format);
//              Handle escaped characters, such as \" to display a literal " or \\ to display a literal \
//              $format = preg_replace('/(?<!\\\\‍)\"/', '', $format);
//                              $format = str_replace(array('\\"', '*'), array('"', ''), $format);
 
                                // Some non-number strings are quoted, so we'll get rid of the quotes, likewise any positional * symbols
                                $format = str_replace(array('"', '*'), '', $format);
 
                                // Find out if we need thousands separator
                                // This is indicated by a comma enclosed by a digit placeholder:
                                //              #,#   or   0,0
                                $useThousands = preg_match('/(#,#|0,0)/', $format);
                                if ($useThousands) {
                                        $format = preg_replace('/0,0/', '00', $format);
                                        $format = preg_replace('/#,#/', '##', $format);
                                }
 
                                // Scale thousands, millions,...
                                // This is indicated by a number of commas after a digit placeholder:
                                //              #,   or 0.0,,
                                $scale = 1; // same as no scale
                                $matches = array();
                                if (preg_match('/(#|0)(,+)/', $format, $matches)) {
                                        $scale = pow(1000, strlen($matches[2]));
 
                                        // strip the commas
                                        $format = preg_replace('/0,+/', '0', $format);
                                        $format = preg_replace('/#,+/', '#', $format);
                                }
 
                                if (preg_match('/#?.*\?\/\?/', $format, $m)) {
                                        //echo 'Format mask is fractional '.$format.' <br />';
                                        if ($value != (int)$value) {
                                                self::_formatAsFraction($value, $format);
                                        }
 
                                } else {
                                        // Handle the number itself
 
                                        // scale number
                                        $value = $value / $scale;
 
                                        // Strip #
                                        $format = preg_replace('/\\#/', '0', $format);
 
                                        $n = "/\[[^\]]+\]/";
                                        $m = preg_replace($n, '', $format);
                                        $number_regex = "/(0+)(\.?)(0*)/";
                                        if (preg_match($number_regex, $m, $matches)) {
                                                $left = $matches[1];
                                                $dec = $matches[2];
                                                $right = $matches[3];
 
                                                // minimun width of formatted number (including dot)
                                                $minWidth = strlen($left) + strlen($dec) + strlen($right);
                                                if ($useThousands) {
                                                        $value = number_format(
                                                                                $value
                                                                                , strlen($right)
                                                                                , PHPExcel_Shared_String::getDecimalSeparator()
                                                                                , PHPExcel_Shared_String::getThousandsSeparator()
                                                                        );
                                                        $value = preg_replace($number_regex, $value, $format);
                                                } else {
                                                        if (preg_match('/[0#]E[+-]0/i', $format)) {
                                                                //      Scientific format
                                                                $value = sprintf('%5.2E', $value);
                                                        } elseif (preg_match('/0([^\d\.]+)0/', $format)) {
                                                                $value = self::_complexNumberFormatMask($value, $format);
                                                        } else {
                                                                $sprintf_pattern = "%0$minWidth." . strlen($right) . "f";
                                                                $value = sprintf($sprintf_pattern, $value);
                                                                $value = preg_replace($number_regex, $value, $format);
                                                        }
                                                }
                                        }
                                }
                                if (preg_match('/\[\$(.*)\]/u', $format, $m)) {
                                        //      Currency or Accounting
                                        $currencyFormat = $m[0];
                                        $currencyCode = $m[1];
                                        list($currencyCode) = explode('-',$currencyCode);
                                        if ($currencyCode == '') {
                                                $currencyCode = PHPExcel_Shared_String::getCurrencyCode();
                                        }
                                        $value = preg_replace('/\[\$([^\]]*)\]/u',$currencyCode,$value);
                                }
                        }
                }
 
                // Additional formatting provided by callback function
                if ($callBack !== null) {
                        list($writerInstance, $function) = $callBack;
                        $value = $writerInstance->$function($value, $formatColor);
                }
 
                return $value;
        }

References $format, $function, $m, $n, _complexNumberFormatMask(), _formatAsDate(), _formatAsFraction(), _formatAsPercentage(), FORMAT_GENERAL, FORMAT_TEXT, PHPExcel_Shared_String\getCurrencyCode(), PHPExcel_Shared_String\getDecimalSeparator(), PHPExcel_Shared_String\getThousandsSeparator(), and sprintf.

Referenced by PHPExcel_Chart_Renderer_jpgraph\_formatDataSetLabels(), PHPExcel_Writer_HTML\_generateRow(), PHPExcel_Worksheet\calculateColumnWidths(), PHPExcel_Calculation_TextData\DOLLAR(), PHPExcel_Cell\getFormattedValue(), PHPExcel_Worksheet\rangeToArray(), and PHPExcel_Calculation_TextData\TEXTFORMAT().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_builtInFormatCode

PHPExcel_Style_NumberFormat::$_builtInFormatCode = 0

protected

Definition at line 104 of file NumberFormat.php.

Referenced by getBuiltInFormatCode().

$_builtInFormats

PHPExcel_Style_NumberFormat::$_builtInFormats

staticprotected

Definition at line 83 of file NumberFormat.php.

$_dateFormatReplacements

PHPExcel_Style_NumberFormat::$_dateFormatReplacements

staticprivate

Definition at line 378 of file NumberFormat.php.

$_dateFormatReplacements12

PHPExcel_Style_NumberFormat::$_dateFormatReplacements12

staticprivate

Initial value:

= array(
                        'hh'    => 'h',
                        'h'             => 'g'
                )

Definition at line 430 of file NumberFormat.php.

$_dateFormatReplacements24

PHPExcel_Style_NumberFormat::$_dateFormatReplacements24

staticprivate

Initial value:

= array(
                        'hh'    => 'H',
                        'h'             => 'G'
                )

Definition at line 421 of file NumberFormat.php.

$_flippedBuiltInFormats

PHPExcel_Style_NumberFormat::$_flippedBuiltInFormats

staticprotected

Definition at line 90 of file NumberFormat.php.

$_formatCode

PHPExcel_Style_NumberFormat::$_formatCode = PHPExcel_Style_NumberFormat::FORMAT_GENERAL

protected

Definition at line 97 of file NumberFormat.php.

Referenced by getFormatCode().

FORMAT_CURRENCY_EUR_SIMPLE

const PHPExcel_Style_NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE = '[$EUR ]#,##0.00_-'

Definition at line 76 of file NumberFormat.php.

FORMAT_CURRENCY_USD

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

Definition at line 75 of file NumberFormat.php.

FORMAT_CURRENCY_USD_SIMPLE

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

Definition at line 74 of file NumberFormat.php.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), PHPExcel_Reader_OOCalc\loadIntoExisting(), and AdvancedValueBinderTest\provider().

FORMAT_DATE_DATETIME

const PHPExcel_Style_NumberFormat::FORMAT_DATE_DATETIME = 'd/m/y h:mm'

Definition at line 63 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_DDMMYYYY

const PHPExcel_Style_NumberFormat::FORMAT_DATE_DDMMYYYY = 'dd/mm/yy'

Definition at line 53 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_DMMINUS

const PHPExcel_Style_NumberFormat::FORMAT_DATE_DMMINUS = 'd-m'

Definition at line 56 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_DMYMINUS

const PHPExcel_Style_NumberFormat::FORMAT_DATE_DMYMINUS = 'd-m-y'

Definition at line 55 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_DMYSLASH

const PHPExcel_Style_NumberFormat::FORMAT_DATE_DMYSLASH = 'd/m/y'

Definition at line 54 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_MYMINUS

const PHPExcel_Style_NumberFormat::FORMAT_DATE_MYMINUS = 'm-y'

Definition at line 57 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME1

const PHPExcel_Style_NumberFormat::FORMAT_DATE_TIME1 = 'h:mm AM/PM'

Definition at line 64 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME2

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

Definition at line 65 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME3

const PHPExcel_Style_NumberFormat::FORMAT_DATE_TIME3 = 'h:mm'

Definition at line 66 of file NumberFormat.php.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), and PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME4

const PHPExcel_Style_NumberFormat::FORMAT_DATE_TIME4 = 'h:mm:ss'

Definition at line 67 of file NumberFormat.php.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), PHPExcel_Shared_Date\isDateTimeFormatCode(), and PHPExcel_Reader_OOCalc\loadIntoExisting().

FORMAT_DATE_TIME5

const PHPExcel_Style_NumberFormat::FORMAT_DATE_TIME5 = 'mm:ss'

Definition at line 68 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME6

const PHPExcel_Style_NumberFormat::FORMAT_DATE_TIME6 = 'h:mm:ss'

Definition at line 69 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME7

const PHPExcel_Style_NumberFormat::FORMAT_DATE_TIME7 = 'i:s.S'

Definition at line 70 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_TIME8

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

Definition at line 71 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_XLSX14

const PHPExcel_Style_NumberFormat::FORMAT_DATE_XLSX14 = 'mm-dd-yy'

Definition at line 58 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_XLSX15

const PHPExcel_Style_NumberFormat::FORMAT_DATE_XLSX15 = 'd-mmm-yy'

Definition at line 59 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode(), and PHPExcel_Reader_OOCalc\loadIntoExisting().

FORMAT_DATE_XLSX16

const PHPExcel_Style_NumberFormat::FORMAT_DATE_XLSX16 = 'd-mmm'

Definition at line 60 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_XLSX17

const PHPExcel_Style_NumberFormat::FORMAT_DATE_XLSX17 = 'mmm-yy'

Definition at line 61 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_XLSX22

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

Definition at line 62 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_YYYYMMDD

const PHPExcel_Style_NumberFormat::FORMAT_DATE_YYYYMMDD = 'yy-mm-dd'

Definition at line 52 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_YYYYMMDD2

const PHPExcel_Style_NumberFormat::FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd'

Definition at line 51 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_DATE_YYYYMMDDSLASH

const PHPExcel_Style_NumberFormat::FORMAT_DATE_YYYYMMDDSLASH = 'yy/mm/dd;@'

Definition at line 72 of file NumberFormat.php.

Referenced by PHPExcel_Shared_Date\isDateTimeFormatCode().

FORMAT_GENERAL

const PHPExcel_Style_NumberFormat::FORMAT_GENERAL = 'General'

Definition at line 39 of file NumberFormat.php.

Referenced by fillBuiltInFormatCodes(), PHPExcel_Shared_Date\isDateTimeFormatCode(), PHPExcel_Reader_Excel2007\load(), PHPExcel_Reader_OOCalc\loadIntoExisting(), PHPExcel_Worksheet\rangeToArray(), setFormatCode(), and toFormattedString().

FORMAT_NUMBER

const PHPExcel_Style_NumberFormat::FORMAT_NUMBER = '0'

Definition at line 43 of file NumberFormat.php.

FORMAT_NUMBER_00

const PHPExcel_Style_NumberFormat::FORMAT_NUMBER_00 = '0.00'

Definition at line 44 of file NumberFormat.php.

FORMAT_NUMBER_COMMA_SEPARATED1

const PHPExcel_Style_NumberFormat::FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00'

Definition at line 45 of file NumberFormat.php.

FORMAT_NUMBER_COMMA_SEPARATED2

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

Definition at line 46 of file NumberFormat.php.

FORMAT_PERCENTAGE

const PHPExcel_Style_NumberFormat::FORMAT_PERCENTAGE = '0%'

Definition at line 48 of file NumberFormat.php.

FORMAT_PERCENTAGE_00

const PHPExcel_Style_NumberFormat::FORMAT_PERCENTAGE_00 = '0.00%'

Definition at line 49 of file NumberFormat.php.

Referenced by PHPExcel_Cell_AdvancedValueBinder\bindValue(), PHPExcel_Reader_OOCalc\loadIntoExisting(), and AdvancedValueBinderTest\provider().

FORMAT_TEXT

const PHPExcel_Style_NumberFormat::FORMAT_TEXT = '@'

Definition at line 41 of file NumberFormat.php.

Referenced by toFormattedString().

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/NumberFormat.php