class PHPExcel_Style_Border in Loft Data Grids 7.2

Same name and namespace in other branches

6.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Style/Border.php \PHPExcel_Style_Border

PHPExcel_Style_Border

Hierarchy

class \PHPExcel_Style_Supervisor
- class \PHPExcel_Style_Border implements PHPExcel_IComparable

Expanded class hierarchy of PHPExcel_Style_Border

File

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

View source

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

}

Members

Name	Modifiers	Type	Description
PHPExcel_Style_Border::$_borderStyle	protected	property	* Border style * *
PHPExcel_Style_Border::$_color	protected	property	* Border color * *
PHPExcel_Style_Border::$_parentPropertyName	protected	property	* Parent property name * *
PHPExcel_Style_Border::applyFromArray	public	function	* Apply styles from array * * <code> * $objPHPExcel->getActiveSheet()->getStyle('B2')->getBorders()->getTop()->applyFromArray( * array( * 'style' => PHPExcel_Style_Border::BORDER_DASHDOT, …
PHPExcel_Style_Border::bindParent	public	function	* Bind parent. Only used for supervisor * * Overrides PHPExcel_Style_Supervisor::bindParent
PHPExcel_Style_Border::BORDER_DASHDOT		constant
PHPExcel_Style_Border::BORDER_DASHDOTDOT		constant
PHPExcel_Style_Border::BORDER_DASHED		constant
PHPExcel_Style_Border::BORDER_DOTTED		constant
PHPExcel_Style_Border::BORDER_DOUBLE		constant
PHPExcel_Style_Border::BORDER_HAIR		constant
PHPExcel_Style_Border::BORDER_MEDIUM		constant
PHPExcel_Style_Border::BORDER_MEDIUMDASHDOT		constant
PHPExcel_Style_Border::BORDER_MEDIUMDASHDOTDOT		constant
PHPExcel_Style_Border::BORDER_MEDIUMDASHED		constant
PHPExcel_Style_Border::BORDER_NONE		constant
PHPExcel_Style_Border::BORDER_SLANTDASHDOT		constant
PHPExcel_Style_Border::BORDER_THICK		constant
PHPExcel_Style_Border::BORDER_THIN		constant
PHPExcel_Style_Border::getBorderStyle	public	function	* Get Border style * *
PHPExcel_Style_Border::getColor	public	function	* Get Border Color * *
PHPExcel_Style_Border::getHashCode	public	function	* Get hash code * * Overrides PHPExcel_IComparable::getHashCode
PHPExcel_Style_Border::getSharedComponent	public	function	* Get the shared style component for the currently active cell in currently active sheet. * Only used for style supervisor * *
PHPExcel_Style_Border::getStyleArray	public	function	* Build style array from subcomponents * *
PHPExcel_Style_Border::setBorderStyle	public	function	* Set Border style * *
PHPExcel_Style_Border::setColor	public	function	* Set Border Color * *
PHPExcel_Style_Border::__construct	public	function	* Create a new PHPExcel_Style_Border * * 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::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.

You are here

class PHPExcel_Style_Border in Loft Data Grids 7.2

Hierarchy

File

Members

API Navigation