You are here

Home » API reference » Loft Data Grids 6.2 » Font.php

class PHPExcel_Style_Font in Loft Data Grids 6.2

Same name and namespace in other branches
  1. 7.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Font.php \PHPExcel_Style_Font

PHPExcel_Style_Font

@category PHPExcel @package PHPExcel_Style @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

Expanded class hierarchy of PHPExcel_Style_Font

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Font.php, line 36

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

}

Members

Namesort descending Modifiers Type Description Overrides
PHPExcel_Style_Font::$_bold protected property * Bold * *
PHPExcel_Style_Font::$_color protected property * Foreground color * *
PHPExcel_Style_Font::$_italic protected property * Italic * *
PHPExcel_Style_Font::$_name protected property * Font Name * *
PHPExcel_Style_Font::$_size protected property * Font Size * *
PHPExcel_Style_Font::$_strikethrough protected property * Strikethrough * *
PHPExcel_Style_Font::$_subScript protected property * Subscript * *
PHPExcel_Style_Font::$_superScript protected property * Superscript * *
PHPExcel_Style_Font::$_underline protected property * Underline * *
PHPExcel_Style_Font::applyFromArray public function * Apply styles from array * * <code> * $objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->applyFromArray( * array( * 'name' => 'Arial', * 'bold' => TRUE, …
PHPExcel_Style_Font::getBold public function * Get Bold * *
PHPExcel_Style_Font::getColor public function * Get Color * *
PHPExcel_Style_Font::getHashCode public function * Get hash code * * Overrides PHPExcel_IComparable::getHashCode
PHPExcel_Style_Font::getItalic public function * Get Italic * *
PHPExcel_Style_Font::getName public function * Get Name * *
PHPExcel_Style_Font::getSharedComponent public function * Get the shared style component for the currently active cell in currently active sheet. * Only used for style supervisor * *
PHPExcel_Style_Font::getSize public function * Get Size * *
PHPExcel_Style_Font::getStrikethrough public function * Get Strikethrough * *
PHPExcel_Style_Font::getStyleArray public function * Build style array from subcomponents * *
PHPExcel_Style_Font::getSubScript public function * Get SubScript * *
PHPExcel_Style_Font::getSuperScript public function * Get SuperScript * *
PHPExcel_Style_Font::getUnderline public function * Get Underline * *
PHPExcel_Style_Font::setBold public function * Set Bold * *
PHPExcel_Style_Font::setColor public function * Set Color * *
PHPExcel_Style_Font::setItalic public function * Set Italic * *
PHPExcel_Style_Font::setName public function * Set Name * *
PHPExcel_Style_Font::setSize public function * Set Size * *
PHPExcel_Style_Font::setStrikethrough public function * Set Strikethrough * *
PHPExcel_Style_Font::setSubScript public function * Set SubScript * *
PHPExcel_Style_Font::setSuperScript public function * Set SuperScript * *
PHPExcel_Style_Font::setUnderline public function * Set Underline * *
PHPExcel_Style_Font::UNDERLINE_DOUBLE constant
PHPExcel_Style_Font::UNDERLINE_DOUBLEACCOUNTING constant
PHPExcel_Style_Font::UNDERLINE_NONE constant
PHPExcel_Style_Font::UNDERLINE_SINGLE constant
PHPExcel_Style_Font::UNDERLINE_SINGLEACCOUNTING constant
PHPExcel_Style_Font::__construct public function * Create a new PHPExcel_Style_Font * * Overrides PHPExcel_Style_Supervisor::__construct
PHPExcel_Style_Supervisor::$_isSupervisor protected property * Supervisor? * *
PHPExcel_Style_Supervisor::$_parent protected property * Parent. Only used for supervisor * *
PHPExcel_Style_Supervisor::bindParent public function * Bind parent. Only used for supervisor * * 2
PHPExcel_Style_Supervisor::getActiveCell public function * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * *
PHPExcel_Style_Supervisor::getActiveSheet public function * Get the currently active sheet. Only used for supervisor * *
PHPExcel_Style_Supervisor::getIsSupervisor public function * Is this a supervisor or a cell style component? * *
PHPExcel_Style_Supervisor::getSelectedCells public function * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * *
PHPExcel_Style_Supervisor::__clone public function * Implement PHP __clone to create a deep clone, not just a shallow copy.