123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294 |
- <?php
- /**
- * PHPExcel
- *
- * Copyright (c) 2006 - 2014 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 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
- * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
- * @version ##VERSION##, ##DATE##
- */
- /**
- * PHPExcel_Style_Border
- *
- * @category PHPExcel
- * @package PHPExcel_Style
- * @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
- */
- class PHPExcel_Style_Border extends PHPExcel_Style_Supervisor implements PHPExcel_IComparable
- {
- /* Border style */
- const BORDER_NONE = 'none';
- const BORDER_DASHDOT = 'dashDot';
- const BORDER_DASHDOTDOT = 'dashDotDot';
- const BORDER_DASHED = 'dashed';
- const BORDER_DOTTED = 'dotted';
- const BORDER_DOUBLE = 'double';
- const BORDER_HAIR = 'hair';
- const BORDER_MEDIUM = 'medium';
- const BORDER_MEDIUMDASHDOT = 'mediumDashDot';
- const BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot';
- const BORDER_MEDIUMDASHED = 'mediumDashed';
- const BORDER_SLANTDASHDOT = 'slantDashDot';
- const BORDER_THICK = 'thick';
- const BORDER_THIN = 'thin';
- /**
- * Border style
- *
- * @var string
- */
- protected $_borderStyle = PHPExcel_Style_Border::BORDER_NONE;
- /**
- * Border color
- *
- * @var PHPExcel_Style_Color
- */
- protected $_color;
- /**
- * Parent property name
- *
- * @var string
- */
- protected $_parentPropertyName;
- /**
- * Create a new PHPExcel_Style_Border
- *
- * @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
- $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_Borders $parent
- * @param string $parentPropertyName
- * @return PHPExcel_Style_Border
- */
- 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_Border
- * @throws PHPExcel_Exception
- */
- public function getSharedComponent()
- {
- switch ($this->_parentPropertyName) {
- case '_allBorders':
- case '_horizontal':
- case '_inside':
- case '_outline':
- case '_vertical':
- throw new PHPExcel_Exception('Cannot get shared component for a pseudo-border.');
- break;
- case '_bottom':
- return $this->_parent->getSharedComponent()->getBottom(); break;
- case '_diagonal':
- return $this->_parent->getSharedComponent()->getDiagonal(); break;
- case '_left':
- return $this->_parent->getSharedComponent()->getLeft(); break;
- case '_right':
- return $this->_parent->getSharedComponent()->getRight(); break;
- case '_top':
- return $this->_parent->getSharedComponent()->getTop(); break;
- }
- }
- /**
- * Build style array from subcomponents
- *
- * @param array $array
- * @return array
- */
- public function getStyleArray($array)
- {
- switch ($this->_parentPropertyName) {
- case '_allBorders':
- $key = 'allborders'; break;
- case '_bottom':
- $key = 'bottom'; break;
- case '_diagonal':
- $key = 'diagonal'; break;
- case '_horizontal':
- $key = 'horizontal'; break;
- case '_inside':
- $key = 'inside'; break;
- case '_left':
- $key = 'left'; break;
- case '_outline':
- $key = 'outline'; break;
- case '_right':
- $key = 'right'; break;
- case '_top':
- $key = 'top'; break;
- case '_vertical':
- $key = 'vertical'; break;
- }
- return $this->_parent->getStyleArray(array($key => $array));
- }
- /**
- * Apply styles from array
- *
- * <code>
- * $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->getTop()->applyFromArray(
- * array(
- * 'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
- * 'color' => array(
- * 'rgb' => '808080'
- * )
- * )
- * );
- * </code>
- *
- * @param array $pStyles Array containing style information
- * @throws PHPExcel_Exception
- * @return PHPExcel_Style_Border
- */
- public function applyFromArray($pStyles = null) {
- if (is_array($pStyles)) {
- if ($this->_isSupervisor) {
- $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($pStyles));
- } else {
- if (isset($pStyles['style'])) {
- $this->setBorderStyle($pStyles['style']);
- }
- if (isset($pStyles['color'])) {
- $this->getColor()->applyFromArray($pStyles['color']);
- }
- }
- } else {
- throw new PHPExcel_Exception("Invalid style array passed.");
- }
- return $this;
- }
- /**
- * Get Border style
- *
- * @return string
- */
- public function getBorderStyle() {
- if ($this->_isSupervisor) {
- return $this->getSharedComponent()->getBorderStyle();
- }
- return $this->_borderStyle;
- }
- /**
- * Set Border style
- *
- * @param string|boolean $pValue
- * When passing a boolean, FALSE equates PHPExcel_Style_Border::BORDER_NONE
- * and TRUE to PHPExcel_Style_Border::BORDER_MEDIUM
- * @return PHPExcel_Style_Border
- */
- public function setBorderStyle($pValue = PHPExcel_Style_Border::BORDER_NONE) {
- if (empty($pValue)) {
- $pValue = PHPExcel_Style_Border::BORDER_NONE;
- } elseif(is_bool($pValue) && $pValue) {
- $pValue = PHPExcel_Style_Border::BORDER_MEDIUM;
- }
- if ($this->_isSupervisor) {
- $styleArray = $this->getStyleArray(array('style' => $pValue));
- $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
- } else {
- $this->_borderStyle = $pValue;
- }
- return $this;
- }
- /**
- * Get Border Color
- *
- * @return PHPExcel_Style_Color
- */
- public function getColor() {
- return $this->_color;
- }
- /**
- * Set Border Color
- *
- * @param PHPExcel_Style_Color $pValue
- * @throws PHPExcel_Exception
- * @return PHPExcel_Style_Border
- */
- 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->_borderStyle
- . $this->_color->getHashCode()
- . __CLASS__
- );
- }
- }
|