File Source for NumberFormat.php

<?php
/**
* PHPExcel
*
* Copyright (c) 2006 - 2009 PHPExcel
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* @category PHPExcel
* @package PHPExcel_Style
* @copyright Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
* @version 1.6.5, 2009-01-05
*/
/** PHPExcel_IComparable */
require_once 'PHPExcel/IComparable.php';
/**
* PHPExcel_Style_NumberFormat
*
* @category PHPExcel
* @package PHPExcel_Style
* @copyright Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
*/
class PHPExcel_Style_NumberFormat implements PHPExcel_IComparable
{
/* Pre-defined formats */
const FORMAT_GENERAL = 'General';
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_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_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_-';
/**
* Excel built-in number formats
*
* @var array
*/
private static $_builtInFormats;
/**
* Format Code
*
* @var string
*/
private $_formatCode;
/**
* Parent Style
*
* @var PHPExcel_Style
*/
private $_parent;
/**
* Parent Borders
*
* @var _parentPropertyName string
*/
private $_parentPropertyName;
/**
* Create a new PHPExcel_Style_NumberFormat
*/
public function __construct()
{
// Initialise values
$this->_formatCode = PHPExcel_Style_NumberFormat::FORMAT_GENERAL;
}
/**
* Property Prepare bind
*
* Configures this object for late binding as a property of a parent object
*
* @param $parent
* @param $parentPropertyName
*/
public function propertyPrepareBind($parent, $parentPropertyName)
{
// Initialize parent PHPExcel_Style for late binding. This relationship purposely ends immediately when this object
// is bound to the PHPExcel_Style object pointed to so as to prevent circular references.
$this->_parent = $parent;
$this->_parentPropertyName = $parentPropertyName;
}
/**
* Property Get Bound
*
* Returns the PHPExcel_Style_NumberFormat that is actual bound to PHPExcel_Style
*
* @return PHPExcel_Style_NumberFormat
*/
private function propertyGetBound() {
if(!isset($this->_parent))
return $this; // I am bound
if($this->_parent->propertyIsBound($this->_parentPropertyName))
return $this->_parent->getNumberFormat(); // Another one is bound
return $this; // No one is bound yet
}
/**
* Property Begin Bind
*
* If no PHPExcel_Style_NumberFormat has been bound to PHPExcel_Style then bind this one. Return the actual bound one.
*
* @return PHPExcel_Style_NumberFormat
*/
private function propertyBeginBind() {
if(!isset($this->_parent))
return $this; // I am already bound
if($this->_parent->propertyIsBound($this->_parentPropertyName))
return $this->_parent->getNumberFormat(); // Another one is already bound
$this->_parent->propertyCompleteBind($this, $this->_parentPropertyName); // Bind myself
$this->_parent = null;
return $this;
}
/**
* Apply styles from array
*
* <code>
* $objPHPExcel->getActiveSheet()->getStyle('B2')->getNumberFormat()->applyFromArray(
* array(
* 'code' => PHPExcel_Style_NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE
* )
* );
* </code>
*
* @param array $pStyles Array containing style information
* @throws Exception
*/
public function applyFromArray($pStyles = null) {
if (is_array($pStyles)) {
if (array_key_exists('code', $pStyles)) {
$this->setFormatCode($pStyles['code']);
}
} else {
throw new Exception("Invalid style array passed.");
}
}
/**
* Get Format Code
*
* @return string
*/
public function getFormatCode() {
return $this->propertyGetBound()->_formatCode;
}
/**
* Set Format Code
*
* @param string $pValue
*/
public function setFormatCode($pValue = PHPExcel_Style_NumberFormat::FORMAT_GENERAL) {
if ($pValue == '') {
$pValue = PHPExcel_Style_NumberFormat::FORMAT_GENERAL;
}
$this->propertyBeginBind()->_formatCode = $pValue;
}
/**
* Get built-in format code
*
* @param int $pIndex
* @return string
*/
public static function builtInFormatCode($pIndex) {
// Clean parameter
$pIndex = intval($pIndex);
// Built-in format codes
if (is_null(self::$_builtInFormats)) {
self::$_builtInFormats = array();
// General
self::$_builtInFormats[0] = '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[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# ??/??';
}
if (array_key_exists($pIndex, self::$_builtInFormats)) {
return self::$_builtInFormats[$pIndex];
}
return '';
}
/**
* Get hash code
*
* @return string Hash code
*/
public function getHashCode() {
$property = $this->propertyGetBound();
return md5(
$property->_formatCode
. __CLASS__
);
}
/**
* Hash index
*
* @var string
*/
private $_hashIndex;
/**
* Get hash index
*
* Note that this index may vary during script execution! Only reliable moment is
* while doing a write of a workbook and when changes are not allowed.
*
* @return string Hash index
*/
public function getHashIndex() {
return $this->_hashIndex;
}
/**
* Set hash index
*
* Note that this index may vary during script execution! Only reliable moment is
* while doing a write of a workbook and when changes are not allowed.
*
* @param string $value Hash index
*/
public function setHashIndex($value) {
$this->_hashIndex = $value;
}
/**
* Implement PHP __clone to create a deep clone, not just a shallow copy.
*/
public function __clone() {
$vars = get_object_vars($this);
foreach ($vars as $key => $value) {
if (is_object($value)) {
$this->$key = clone $value;
} else {
$this->$key = $value;
}
}
}
/**
* Convert a value in a pre-defined format to a PHP string
*
* @param mixed $value Value to format
* @param string $format Format code
* @return string Formatted string
*/
public static function toFormattedString($value = '', $format = '') {
if (preg_match("/^[hmsdy]/i", $format)) { // custom datetime format
// dvc: convert Excel formats to PHP date formats
// first remove escapes related to non-format characters
$format = str_replace('\\', '', $format);
// 4-digit year
$format = str_replace('yyyy', 'Y', $format);
// 2-digit year
$format = str_replace('yy', 'y', $format);
// first letter of month - no php equivalent
$format = str_replace('mmmmm', 'M', $format);
// full month name
$format = str_replace('mmmm', 'F', $format);
// short month name
$format = str_replace('mmm', 'M', $format);
// mm is minutes if time or month w/leading zero
$format = str_replace(':mm', ':i', $format);
// tmp place holder
$format = str_replace('mm', 'x', $format);
// month no leading zero
$format = str_replace('m', 'n', $format);
// month leading zero
$format = str_replace('x', 'm', $format);
// 12-hour suffix
$format = str_replace('AM/PM', 'A', $format);
// tmp place holder
$format = str_replace('dd', 'x', $format);
// days no leading zero
$format = str_replace('d', 'j', $format);
// days leading zero
$format = str_replace('x', 'd', $format);
// seconds
$format = str_replace('ss', 's', $format);
// fractional seconds - no php equivalent
$format = str_replace('.S', '', $format);
if (!strpos($format,'A')) { // 24-hour format
$format = str_replace('h', 'H', $format);
}
// user defined flag symbol????
$format = str_replace(';@', '', $format);
return date($format, (1 * $value));
} else if (preg_match('/%$/', $format)) { // % number format
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);
return sprintf($format, $value);
} else {
if (preg_match ("/^([0-9.,-]+)$/", $value)) {
switch ($format) {
case self::FORMAT_NUMBER:
return sprintf('%1.0f', $value);
case self::FORMAT_NUMBER_00:
return sprintf('%1.2f', $value);
case self::FORMAT_NUMBER_COMMA_SEPARATED1:
case self::FORMAT_NUMBER_COMMA_SEPARATED2:
return number_format($value, 2, ',', '.');
case self::FORMAT_PERCENTAGE:
return round( (100 * $value), 0) . '%';
case self::FORMAT_PERCENTAGE_00:
return round( (100 * $value), 2) . '%';
case self::FORMAT_DATE_YYYYMMDD:
return date('Y-m-d', (1 * $value));
case self::FORMAT_DATE_DDMMYYYY:
return date('d/m/Y', (1 * $value));
case 'yyyy/mm/dd;@':
return date('Y/m/d', (1 * $value));
case self::FORMAT_CURRENCY_USD_SIMPLE:
return '$' . number_format($value, 2);
case self::FORMAT_CURRENCY_USD:
return '$' . number_format($value);
case self::FORMAT_CURRENCY_EUR_SIMPLE:
return 'EUR ' . sprintf('%1.2f', $value);
}
}
return $value;
}
}
}

Source for file NumberFormat.php