Rev 2388 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<?php/*** PHPExcel** Copyright (c) 2006 - 2013 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 - 2013 PHPExcel (http://www.codeplex.com/PHPExcel)* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL* @version ##VERSION##, ##DATE##*//*** PHPExcel_Style_Color** @category PHPExcel* @package PHPExcel_Style* @copyright Copyright (c) 2006 - 2013 PHPExcel (http://www.codeplex.com/PHPExcel)*/class PHPExcel_Style_Color extends PHPExcel_Style_Supervisor implements PHPExcel_IComparable{/* Colors */const COLOR_BLACK = 'FF000000';const COLOR_WHITE = 'FFFFFFFF';const COLOR_RED = 'FFFF0000';const COLOR_DARKRED = 'FF800000';const COLOR_BLUE = 'FF0000FF';const COLOR_DARKBLUE = 'FF000080';const COLOR_GREEN = 'FF00FF00';const COLOR_DARKGREEN = 'FF008000';const COLOR_YELLOW = 'FFFFFF00';const COLOR_DARKYELLOW = 'FF808000';/*** Indexed colors array** @var array*/protected static $_indexedColors;/*** ARGB - Alpha RGB** @var string*/protected $_argb = NULL;/*** Parent property name** @var string*/protected $_parentPropertyName;/*** Create a new PHPExcel_Style_Color** @param string $pARGB ARGB value for the colour* @param boolean $isSupervisor Flag indicating if this is a supervisor or not* Leave this value at default unless you understand exactly what* its ramifications are* @param 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*/public function __construct($pARGB = PHPExcel_Style_Color::COLOR_BLACK, $isSupervisor = FALSE, $isConditional = FALSE){// Supervisor?parent::__construct($isSupervisor);// Initialise valuesif (!$isConditional) {$this->_argb = $pARGB;}}/*** Bind parent. Only used for supervisor** @param mixed $parent* @param string $parentPropertyName* @return PHPExcel_Style_Color*/public function bindParent($parent, $parentPropertyName=NULL){$this->_parent = $parent;$this->_parentPropertyName = $parentPropertyName;return $this;}/*** Get the shared style component for the currently active cell in currently active sheet.* Only used for style supervisor** @return PHPExcel_Style_Color*/public function getSharedComponent(){switch ($this->_parentPropertyName) {case '_endColor':return $this->_parent->getSharedComponent()->getEndColor(); break;case '_color':return $this->_parent->getSharedComponent()->getColor(); break;case '_startColor':return $this->_parent->getSharedComponent()->getStartColor(); break;}}/*** Build style array from subcomponents** @param array $array* @return array*/public function getStyleArray($array){switch ($this->_parentPropertyName) {case '_endColor':$key = 'endcolor';break;case '_color':$key = 'color';break;case '_startColor':$key = 'startcolor';break;}return $this->_parent->getStyleArray(array($key => $array));}/*** Apply styles from array** <code>* $objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray( array('rgb' => '808080') );* </code>** @param array $pStyles Array containing style information* @throws PHPExcel_Exception* @return PHPExcel_Style_Color*/public function applyFromArray($pStyles = NULL) {if (is_array($pStyles)) {if ($this->_isSupervisor) {$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));} else {if (array_key_exists('rgb', $pStyles)) {$this->setRGB($pStyles['rgb']);}if (array_key_exists('argb', $pStyles)) {$this->setARGB($pStyles['argb']);}}} else {throw new PHPExcel_Exception("Invalid style array passed.");}return $this;}/*** Get ARGB** @return string*/public function getARGB() {if ($this->_isSupervisor) {return $this->getSharedComponent()->getARGB();}return $this->_argb;}/*** Set ARGB** @param string $pValue* @return PHPExcel_Style_Color*/public function setARGB($pValue = PHPExcel_Style_Color::COLOR_BLACK) {if ($pValue == '') {$pValue = PHPExcel_Style_Color::COLOR_BLACK;}if ($this->_isSupervisor) {$styleArray = $this->getStyleArray(array('argb' => $pValue));$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);} else {$this->_argb = $pValue;}return $this;}/*** Get RGB** @return string*/public function getRGB() {if ($this->_isSupervisor) {return $this->getSharedComponent()->getRGB();}return substr($this->_argb, 2);}/*** Set RGB** @param string $pValue RGB value* @return PHPExcel_Style_Color*/public function setRGB($pValue = '000000') {if ($pValue == '') {$pValue = '000000';}if ($this->_isSupervisor) {$styleArray = $this->getStyleArray(array('argb' => 'FF' . $pValue));$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);} else {$this->_argb = 'FF' . $pValue;}return $this;}/*** Get a specified colour component of an RGB value** @private* @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE* @param int $offset Position within the RGB value to extract* @param boolean $hex Flag indicating whether the component should be returned as a hex or a* decimal value* @return string The extracted colour component*/private static function _getColourComponent($RGB,$offset,$hex=TRUE) {$colour = substr($RGB, $offset, 2);if (!$hex)$colour = hexdec($colour);return $colour;}/*** Get the red colour component of an RGB value** @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE* @param boolean $hex Flag indicating whether the component should be returned as a hex or a* decimal value* @return string The red colour component*/public static function getRed($RGB,$hex=TRUE) {return self::_getColourComponent($RGB, strlen($RGB) - 6, $hex);}/*** Get the green colour component of an RGB value** @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE* @param boolean $hex Flag indicating whether the component should be returned as a hex or a* decimal value* @return string The green colour component*/public static function getGreen($RGB,$hex=TRUE) {return self::_getColourComponent($RGB, strlen($RGB) - 4, $hex);}/*** Get the blue colour component of an RGB value** @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE* @param boolean $hex Flag indicating whether the component should be returned as a hex or a* decimal value* @return string The blue colour component*/public static function getBlue($RGB,$hex=TRUE) {return self::_getColourComponent($RGB, strlen($RGB) - 2, $hex);}/*** Adjust the brightness of a color** @param string $hex The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)* @param float $adjustPercentage The percentage by which to adjust the colour as a float from -1 to 1* @return string The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)*/public static function changeBrightness($hex, $adjustPercentage) {$rgba = (strlen($hex) == 8);$red = self::getRed($hex, FALSE);$green = self::getGreen($hex, FALSE);$blue = self::getBlue($hex, FALSE);if ($adjustPercentage > 0) {$red += (255 - $red) * $adjustPercentage;$green += (255 - $green) * $adjustPercentage;$blue += (255 - $blue) * $adjustPercentage;} else {$red += $red * $adjustPercentage;$green += $green * $adjustPercentage;$blue += $blue * $adjustPercentage;}if ($red < 0) $red = 0;elseif ($red > 255) $red = 255;if ($green < 0) $green = 0;elseif ($green > 255) $green = 255;if ($blue < 0) $blue = 0;elseif ($blue > 255) $blue = 255;$rgb = strtoupper( str_pad(dechex($red), 2, '0', 0) .str_pad(dechex($green), 2, '0', 0) .str_pad(dechex($blue), 2, '0', 0));return (($rgba) ? 'FF' : '') . $rgb;}/*** Get indexed color** @param int $pIndex Index entry point into the colour array* @param boolean $background Flag to indicate whether default background or foreground colour* should be returned if the indexed colour doesn't exist* @return PHPExcel_Style_Color*/public static function indexedColor($pIndex, $background=FALSE) {// Clean parameter$pIndex = intval($pIndex);// Indexed colorsif (is_null(self::$_indexedColors)) {self::$_indexedColors = array(1 => 'FF000000', // System Colour #1 - Black2 => 'FFFFFFFF', // System Colour #2 - White3 => 'FFFF0000', // System Colour #3 - Red4 => 'FF00FF00', // System Colour #4 - Green5 => 'FF0000FF', // System Colour #5 - Blue6 => 'FFFFFF00', // System Colour #6 - Yellow7 => 'FFFF00FF', // System Colour #7- Magenta8 => 'FF00FFFF', // System Colour #8- Cyan9 => 'FF800000', // Standard Colour #910 => 'FF008000', // Standard Colour #1011 => 'FF000080', // Standard Colour #1112 => 'FF808000', // Standard Colour #1213 => 'FF800080', // Standard Colour #1314 => 'FF008080', // Standard Colour #1415 => 'FFC0C0C0', // Standard Colour #1516 => 'FF808080', // Standard Colour #1617 => 'FF9999FF', // Chart Fill Colour #1718 => 'FF993366', // Chart Fill Colour #1819 => 'FFFFFFCC', // Chart Fill Colour #1920 => 'FFCCFFFF', // Chart Fill Colour #2021 => 'FF660066', // Chart Fill Colour #2122 => 'FFFF8080', // Chart Fill Colour #2223 => 'FF0066CC', // Chart Fill Colour #2324 => 'FFCCCCFF', // Chart Fill Colour #2425 => 'FF000080', // Chart Line Colour #2526 => 'FFFF00FF', // Chart Line Colour #2627 => 'FFFFFF00', // Chart Line Colour #2728 => 'FF00FFFF', // Chart Line Colour #2829 => 'FF800080', // Chart Line Colour #2930 => 'FF800000', // Chart Line Colour #3031 => 'FF008080', // Chart Line Colour #3132 => 'FF0000FF', // Chart Line Colour #3233 => 'FF00CCFF', // Standard Colour #3334 => 'FFCCFFFF', // Standard Colour #3435 => 'FFCCFFCC', // Standard Colour #3536 => 'FFFFFF99', // Standard Colour #3637 => 'FF99CCFF', // Standard Colour #3738 => 'FFFF99CC', // Standard Colour #3839 => 'FFCC99FF', // Standard Colour #3940 => 'FFFFCC99', // Standard Colour #4041 => 'FF3366FF', // Standard Colour #4142 => 'FF33CCCC', // Standard Colour #4243 => 'FF99CC00', // Standard Colour #4344 => 'FFFFCC00', // Standard Colour #4445 => 'FFFF9900', // Standard Colour #4546 => 'FFFF6600', // Standard Colour #4647 => 'FF666699', // Standard Colour #4748 => 'FF969696', // Standard Colour #4849 => 'FF003366', // Standard Colour #4950 => 'FF339966', // Standard Colour #5051 => 'FF003300', // Standard Colour #5152 => 'FF333300', // Standard Colour #5253 => 'FF993300', // Standard Colour #5354 => 'FF993366', // Standard Colour #5455 => 'FF333399', // Standard Colour #5556 => 'FF333333' // Standard Colour #56);}if (array_key_exists($pIndex, self::$_indexedColors)) {return new PHPExcel_Style_Color(self::$_indexedColors[$pIndex]);}if ($background) {return new PHPExcel_Style_Color('FFFFFFFF');}return new PHPExcel_Style_Color('FF000000');}/*** Get hash code** @return string Hash code*/public function getHashCode() {if ($this->_isSupervisor) {return $this->getSharedComponent()->getHashCode();}return md5($this->_argb. __CLASS__);}}