Font.php

Go to the documentation of this file.

<?php
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';

        protected $_name                        = 'Calibri';

        protected $_size                        = 11;

        protected $_bold                        = FALSE;

        protected $_italic              = FALSE;

        protected $_superScript = FALSE;

        protected $_subScript           = FALSE;

        protected $_underline           = self::UNDERLINE_NONE;

        protected $_strikethrough       = FALSE;

        protected $_color;

        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');
                }
        }

        public function getSharedComponent()
        {
                return $this->_parent->getSharedComponent()->getFont();
        }

        public function getStyleArray($array)
        {
                return array('font' => $array);
        }

        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;
        }

        public function getName() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getName();
                }
                return $this->_name;
        }

        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;
        }

        public function getSize() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getSize();
                }
                return $this->_size;
        }

        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;
        }

        public function getBold() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getBold();
                }
                return $this->_bold;
        }

        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;
        }

        public function getItalic() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getItalic();
                }
                return $this->_italic;
        }

        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;
        }

        public function getSuperScript() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getSuperScript();
                }
                return $this->_superScript;
        }

        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;
        }

        public function getSubScript() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getSubScript();
                }
                return $this->_subScript;
        }

        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;
        }

        public function getUnderline() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getUnderline();
                }
                return $this->_underline;
        }

        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;
        }

        public function getStrikethrough() {
                if ($this->_isSupervisor) {
                        return $this->getSharedComponent()->getStrikethrough();
                }
                return $this->_strikethrough;
        }

        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;
        }

        public function getColor() {
                return $this->_color;
        }

        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;
        }

        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__
                );
        }

}