PHPExcel_Style

# Source for file Protection.php Documentation is available at Protection.php <?php /** * PHPExcel * * Copyright (c) 2006 - 2011 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 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL * @version 1.4.5, 2007-08-23 */ /** * PHPExcel_Style_Protection * * @category PHPExcel * @package PHPExcel_Style * @copyright Copyright (c) 2006 - 2011 PHPExcel (http://www.codeplex.com/PHPExcel) */ class PHPExcel_Style_Protection implements PHPExcel_IComparable { /** Protection styles */ const PROTECTION_INHERIT = 'inherit'; const PROTECTION_PROTECTED = 'protected'; const PROTECTION_UNPROTECTED = 'unprotected'; /** * Locked * * @var string */ private $_locked; /** * Hidden * * @var string */ private $_hidden; /** * Parent Borders * * @var _parentPropertyName string */ private $_parentPropertyName; /** * Supervisor? * * @var boolean */ private $_isSupervisor; /** * Parent. Only used for supervisor * * @var PHPExcel_Style */ private $_parent; /** * Create a new PHPExcel_Style_Protection */ public function __construct($isSupervisor = false) { // Supervisor? $this->_isSupervisor = $isSupervisor; // Initialise values $this->_locked = self::PROTECTION_INHERIT; $this->_hidden = self::PROTECTION_INHERIT; } /** * Bind parent. Only used for supervisor * * @param PHPExcel_Style $parent * @return PHPExcel_Style_Protection */ public function bindParent($parent) { $this->_parent = $parent; return $this; } /** * Is this a supervisor or a real style component? * * @return boolean */ public function getIsSupervisor() { return $this->_isSupervisor; } /** * 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(); } /** * Get the currently active sheet. Only used for supervisor * * @return PHPExcel_Worksheet */ public function getActiveSheet() { return $this->_parent->getActiveSheet(); } /** * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * * @return string E.g. 'A1' */ public function getSelectedCells() { return $this->getActiveSheet()->getSelectedCells(); } /** * Get the currently active cell coordinate in currently active sheet. * Only used for supervisor * * @return string E.g. 'A1' */ public function getActiveCell() { return $this->getActiveSheet()->getActiveCell(); } /** * 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 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 (array_key_exists('locked', $pStyles)) { $this->setLocked($pStyles['locked']); } if (array_key_exists('hidden', $pStyles)) { $this->setHidden($pStyles['hidden']); } } } else { throw new 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__ ); } /** * Implement PHP __clone to create a deep clone, not just a shallow copy. */ public function __clone() { $vars = get_object_vars($this); foreach ($vars as $key => $value) { if ((is_object($value)) && ($key != '_parent')) { $this->$key = clone $value; } else { $this->$key = $value; } } } } Documentation generated on Sun, 27 Feb 2011 16:33:30 -0800 by phpDocumentor 1.4.3