123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543 |
- <?php
- /**
- * PHPExcel_Style_Font
- *
- * Copyright (c) 2006 - 2015 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 - 2015 PHPExcel (http://www.codeplex.com/PHPExcel)
- * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
- * @version ##VERSION##, ##DATE##
- */
- class PHPExcel_Style_Font extends PHPExcel_Style_Supervisor 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
- */
- protected $name = 'Calibri';
- /**
- * Font Size
- *
- * @var float
- */
- protected $size = 11;
- /**
- * Bold
- *
- * @var boolean
- */
- protected $bold = false;
- /**
- * Italic
- *
- * @var boolean
- */
- protected $italic = false;
- /**
- * Superscript
- *
- * @var boolean
- */
- protected $superScript = false;
- /**
- * Subscript
- *
- * @var boolean
- */
- protected $subScript = false;
- /**
- * Underline
- *
- * @var string
- */
- protected $underline = self::UNDERLINE_NONE;
- /**
- * Strikethrough
- *
- * @var boolean
- */
- protected $strikethrough = false;
- /**
- * Foreground color
- *
- * @var PHPExcel_Style_Color
- */
- protected $color;
- /**
- * Create a new PHPExcel_Style_Font
- *
- * @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($isSupervisor = false, $isConditional = false)
- {
- // Supervisor?
- parent::__construct($isSupervisor);
- // Initialise values
- if ($isConditional) {
- $this->name = null;
- $this->size = null;
- $this->bold = null;
- $this->italic = null;
- $this->superScript = null;
- $this->subScript = null;
- $this->underline = null;
- $this->strikethrough = null;
- $this->color = new PHPExcel_Style_Color(PHPExcel_Style_Color::COLOR_BLACK, $isSupervisor, $isConditional);
- } else {
- $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');
- }
- }
- /**
- * 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();
- }
- /**
- * 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 PHPExcel_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 PHPExcel_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|boolean $pValue PHPExcel_Style_Font underline type
- * If a boolean is passed, then TRUE equates to UNDERLINE_SINGLE,
- * false equates to UNDERLINE_NONE
- * @return PHPExcel_Style_Font
- */
- public function setUnderline($pValue = self::UNDERLINE_NONE)
- {
- if (is_bool($pValue)) {
- $pValue = ($pValue) ? self::UNDERLINE_SINGLE : self::UNDERLINE_NONE;
- } elseif ($pValue == '') {
- $pValue = self::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 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 PHPExcel_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__
- );
- }
- }
|