PHPExcel_Style

# Source for file Font.php Documentation is available at Font.php <?php /** * PHPExcel * * Copyright (c) 2006 - 2011 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 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL * @version 1.7.6, 2011-02-27 */ /** * PHPExcel_Style_Font * * @category PHPExcel * @package PHPExcel_Style * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) */ class PHPExcel_Style_Font implements PHPExcel_IComparable { /* Underline types */ const UNDERLINE_NONE = 'none'; const UNDERLINE_DOUBLE = 'double'; const UNDERLINE_DOUBLEACCOUNTING = 'doubleAccounting'; const UNDERLINE_SINGLE = 'single'; const UNDERLINE_SINGLEACCOUNTING = 'singleAccounting'; /** * Font Name * * @var string */ private $_name = 'Calibri'; /** * Font Size * * @var float */ private $_size = 11; /** * Bold * * @var boolean */ private $_bold = false; /** * Italic * * @var boolean */ private $_italic = false; /** * Superscript * * @var boolean */ private $_superScript = false; /** * Subscript * * @var boolean */ private $_subScript = false; /** * Underline * * @var string */ private $_underline = PHPExcel_Style_Font::UNDERLINE_NONE; /** * Strikethrough * * @var boolean */ private $_strikethrough = false; /** * Foreground color * * @var PHPExcel_Style_Color */ private $_color; /** * Parent Borders * * @var _parentPropertyName string */ private $_parentPropertyName; /** * Supervisor? * * @var boolean */ private $_isSupervisor; /** * Parent. Only used for supervisor * * @var PHPExcel_Style */ private $_parent; /** * Create a new PHPExcel_Style_Font */ public function __construct($isSupervisor = false) { // Supervisor? $this->_isSupervisor = $isSupervisor; // Initialise values $this->_color = new PHPExcel_Style_Color(PHPExcel_Style_Color::COLOR_BLACK, $isSupervisor); // bind parent if we are a supervisor if ($isSupervisor) { $this->_color->bindParent($this, '_color'); } } /** * Bind parent. Only used for supervisor * * @param PHPExcel_Style $parent * @return PHPExcel_Style_Font */ public function bindParent($parent) { $this->_parent = $parent; } /** * Is this a supervisor or a real style component? * * @return boolean */ public function getIsSupervisor() { return $this->_isSupervisor; } /** * Get the shared style component for the currently active cell in currently active sheet. * Only used for style supervisor * * @return PHPExcel_Style_Font */ public function getSharedComponent() { return $this->_parent->getSharedComponent()->getFont(); } /** * Get the currently active sheet. Only used for supervisor * * @return PHPExcel_Worksheet */ public function getActiveSheet() { return $this->_parent->getActiveSheet(); } /** * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * * @return string E.g. 'A1' */ public function getSelectedCells() { return $this->getActiveSheet()->getSelectedCells(); } /** * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * * @return string E.g. 'A1' */ public function getActiveCell() { return $this->getActiveSheet()->getActiveCell(); } /** * Build style array from subcomponents * * @param array $array * @return array */ public function getStyleArray($array) { return array('font' => $array); } /** * Apply styles from array * * <code> * $objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->applyFromArray( * array( * 'name' => 'Arial', * 'bold' => true, * 'italic' => false, * 'underline' => PHPExcel_Style_Font::UNDERLINE_DOUBLE, * 'strike' => false, * 'color' => array( * 'rgb' => '808080' * ) * ) * ); * </code> * * @param array $pStyles Array containing style information * @throws Exception * @return PHPExcel_Style_Font */ 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('name', $pStyles)) { $this->setName($pStyles['name']); } if (array_key_exists('bold', $pStyles)) { $this->setBold($pStyles['bold']); } if (array_key_exists('italic', $pStyles)) { $this->setItalic($pStyles['italic']); } if (array_key_exists('superScript', $pStyles)) { $this->setSuperScript($pStyles['superScript']); } if (array_key_exists('subScript', $pStyles)) { $this->setSubScript($pStyles['subScript']); } if (array_key_exists('underline', $pStyles)) { $this->setUnderline($pStyles['underline']); } if (array_key_exists('strike', $pStyles)) { $this->setStrikethrough($pStyles['strike']); } if (array_key_exists('color', $pStyles)) { $this->getColor()->applyFromArray($pStyles['color']); } if (array_key_exists('size', $pStyles)) { $this->setSize($pStyles['size']); } } } else { throw new Exception("Invalid style array passed."); } return $this; } /** * Get Name * * @return string */ public function getName() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getName(); } return $this->_name; } /** * Set Name * * @param string $pValue * @return PHPExcel_Style_Font */ public function setName($pValue = 'Calibri') { if ($pValue == '') { $pValue = 'Calibri'; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('name' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_name = $pValue; } return $this; } /** * Get Size * * @return double */ public function getSize() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getSize(); } return $this->_size; } /** * Set Size * * @param double $pValue * @return PHPExcel_Style_Font */ public function setSize($pValue = 10) { if ($pValue == '') { $pValue = 10; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('size' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_size = $pValue; } return $this; } /** * Get Bold * * @return boolean */ public function getBold() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getBold(); } return $this->_bold; } /** * Set Bold * * @param boolean $pValue * @return PHPExcel_Style_Font */ public function setBold($pValue = false) { if ($pValue == '') { $pValue = false; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('bold' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_bold = $pValue; } return $this; } /** * Get Italic * * @return boolean */ public function getItalic() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getItalic(); } return $this->_italic; } /** * Set Italic * * @param boolean $pValue * @return PHPExcel_Style_Font */ public function setItalic($pValue = false) { if ($pValue == '') { $pValue = false; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('italic' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_italic = $pValue; } return $this; } /** * Get SuperScript * * @return boolean */ public function getSuperScript() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getSuperScript(); } return $this->_superScript; } /** * Set SuperScript * * @param boolean $pValue * @return PHPExcel_Style_Font */ public function setSuperScript($pValue = false) { if ($pValue == '') { $pValue = false; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('superScript' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_superScript = $pValue; $this->_subScript = !$pValue; } return $this; } /** * Get SubScript * * @return boolean */ public function getSubScript() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getSubScript(); } return $this->_subScript; } /** * Set SubScript * * @param boolean $pValue * @return PHPExcel_Style_Font */ public function setSubScript($pValue = false) { if ($pValue == '') { $pValue = false; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('subScript' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_subScript = $pValue; $this->_superScript = !$pValue; } return $this; } /** * Get Underline * * @return string */ public function getUnderline() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getUnderline(); } return $this->_underline; } /** * Set Underline * * @param string $pValue PHPExcel_Style_Font underline type * @return PHPExcel_Style_Font */ public function setUnderline($pValue = PHPExcel_Style_Font::UNDERLINE_NONE) { if ($pValue == '') { $pValue = PHPExcel_Style_Font::UNDERLINE_NONE; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('underline' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_underline = $pValue; } return $this; } /** * Get Striketrough * * @deprecated Use getStrikethrough() instead. * @return boolean */ public function getStriketrough() { return $this->getStrikethrough(); } /** * Set Striketrough * * @deprecated Use setStrikethrough() instead. * @param boolean $pValue * @return PHPExcel_Style_Font */ public function setStriketrough($pValue = false) { return $this->setStrikethrough($pValue); } /** * Get Strikethrough * * @return boolean */ public function getStrikethrough() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getStrikethrough(); } return $this->_strikethrough; } /** * Set Strikethrough * * @param boolean $pValue * @return PHPExcel_Style_Font */ public function setStrikethrough($pValue = false) { if ($pValue == '') { $pValue = false; } if ($this->_isSupervisor) { $styleArray = $this->getStyleArray(array('strike' => $pValue)); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_strikethrough = $pValue; } return $this; } /** * Get Color * * @return PHPExcel_Style_Color */ public function getColor() { return $this->_color; } /** * Set Color * * @param PHPExcel_Style_Color $pValue * @throws Exception * @return PHPExcel_Style_Font */ public function setColor(PHPExcel_Style_Color $pValue = null) { // make sure parameter is a real color and not a supervisor $color = $pValue->getIsSupervisor() ? $pValue->getSharedComponent() : $pValue; if ($this->_isSupervisor) { $styleArray = $this->getColor()->getStyleArray(array('argb' => $color->getARGB())); $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray); } else { $this->_color = $color; } return $this; } /** * Get hash code * * @return string Hash code */ public function getHashCode() { if ($this->_isSupervisor) { return $this->getSharedComponent()->getHashCode(); } return md5( $this->_name . $this->_size . ($this->_bold ? 't' : 'f') . ($this->_italic ? 't' : 'f') . ($this->_superScript ? 't' : 'f') . ($this->_subScript ? 't' : 'f') . $this->_underline . ($this->_strikethrough ? 't' : 'f') . $this->_color->getHashCode() . __CLASS__ ); } /** * 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)) && ($key != '_parent')) { $this->$key = clone $value; } else { $this->$key = $value; } } } } Documentation generated on Sun, 27 Feb 2011 16:31:40 -0800 by phpDocumentor 1.4.3