class PHPExcel_Style_Protection in Loft Data Grids 6.2

PHPExcel_Style_Protection

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

Hierarchy

• class \PHPExcel_Style_Supervisor
  • class \PHPExcel_Style_Protection implements PHPExcel_IComparable

File

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

class PHPExcel_Style_Protection extends PHPExcel_Style_Supervisor implements PHPExcel_IComparable {

  /** Protection styles */
  const PROTECTION_INHERIT = 'inherit';
  const PROTECTION_PROTECTED = 'protected';
  const PROTECTION_UNPROTECTED = 'unprotected';

  /**
   * Locked
   *
   * @var string
   */
  protected $_locked;

  /**
   * Hidden
   *
   * @var string
   */
  protected $_hidden;

  /**
   * Create a new PHPExcel_Style_Protection
   *
   * @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->_locked = self::PROTECTION_INHERIT;
      $this->_hidden = self::PROTECTION_INHERIT;
    }
  }

  /**
   * Get the shared style component for the currently active cell in currently active sheet.
   * Only used for style supervisor
   *
   * @return PHPExcel_Style_Protection
   */
  public function getSharedComponent() {
    return $this->_parent
      ->getSharedComponent()
      ->getProtection();
  }

  /**
   * Build style array from subcomponents
   *
   * @param array $array
   * @return array
   */
  public function getStyleArray($array) {
    return array(
      'protection' => $array,
    );
  }

  /**
   * Apply styles from array
   *
   * <code>
   * $objPHPExcel->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray(
   *		array(
   *			'locked' => TRUE,
   *			'hidden' => FALSE
   *		)
   * );
   * </code>
   *
   * @param	array	$pStyles	Array containing style information
   * @throws	PHPExcel_Exception
   * @return PHPExcel_Style_Protection
   */
  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['locked'])) {
          $this
            ->setLocked($pStyles['locked']);
        }
        if (isset($pStyles['hidden'])) {
          $this
            ->setHidden($pStyles['hidden']);
        }
      }
    }
    else {
      throw new PHPExcel_Exception("Invalid style array passed.");
    }
    return $this;
  }

  /**
   * Get locked
   *
   * @return string
   */
  public function getLocked() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getLocked();
    }
    return $this->_locked;
  }

  /**
   * Set locked
   *
   * @param string $pValue
   * @return PHPExcel_Style_Protection
   */
  public function setLocked($pValue = self::PROTECTION_INHERIT) {
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'locked' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_locked = $pValue;
    }
    return $this;
  }

  /**
   * Get hidden
   *
   * @return string
   */
  public function getHidden() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getHidden();
    }
    return $this->_hidden;
  }

  /**
   * Set hidden
   *
   * @param string $pValue
   * @return PHPExcel_Style_Protection
   */
  public function setHidden($pValue = self::PROTECTION_INHERIT) {
    if ($this->_isSupervisor) {
      $styleArray = $this
        ->getStyleArray(array(
        'hidden' => $pValue,
      ));
      $this
        ->getActiveSheet()
        ->getStyle($this
        ->getSelectedCells())
        ->applyFromArray($styleArray);
    }
    else {
      $this->_hidden = $pValue;
    }
    return $this;
  }

  /**
   * Get hash code
   *
   * @return string	Hash code
   */
  public function getHashCode() {
    if ($this->_isSupervisor) {
      return $this
        ->getSharedComponent()
        ->getHashCode();
    }
    return md5($this->_locked . $this->_hidden . __CLASS__);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_Style_Protection::$_hidden	protected	property	* Hidden * *
PHPExcel_Style_Protection::$_locked	protected	property	* Locked * *
PHPExcel_Style_Protection::applyFromArray	public	function	Apply styles from array
PHPExcel_Style_Protection::getHashCode	public	function	* Get hash code * * Overrides PHPExcel_IComparable::getHashCode
PHPExcel_Style_Protection::getHidden	public	function	Get hidden
PHPExcel_Style_Protection::getLocked	public	function	Get locked
PHPExcel_Style_Protection::getSharedComponent	public	function	* Get the shared style component for the currently active cell in currently active sheet. * Only used for style supervisor * *
PHPExcel_Style_Protection::getStyleArray	public	function	* Build style array from subcomponents * *
PHPExcel_Style_Protection::PROTECTION_INHERIT		constant	Protection styles
PHPExcel_Style_Protection::PROTECTION_PROTECTED		constant
PHPExcel_Style_Protection::PROTECTION_UNPROTECTED		constant
PHPExcel_Style_Protection::setHidden	public	function	Set hidden
PHPExcel_Style_Protection::setLocked	public	function	Set locked
PHPExcel_Style_Protection::__construct	public	function	Create a new PHPExcel_Style_Protection * * 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.