PHPExcel_Worksheet

# Source for file Protection.php Documentation is available at Protection.php <?php /** * PHPExcel * * Copyright (c) 2006 - 2010 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_Worksheet * @copyright Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL * @version 1.7.2, 2010-01-11 */ /** PHPExcel root directory */ if (!defined('PHPEXCEL_ROOT')) { /** * @ignore */ define('PHPEXCEL_ROOT', dirname(__FILE__) . '/../../'); } /** PHPExcel_Shared_PasswordHasher */ require_once PHPEXCEL_ROOT . 'PHPExcel/Shared/PasswordHasher.php'; /** * PHPExcel_Worksheet_Protection * * @category PHPExcel * @package PHPExcel_Worksheet * @copyright Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) */ class PHPExcel_Worksheet_Protection { /** * Sheet * * @var boolean */ private $_sheet; /** * Objects * * @var boolean */ private $_objects; /** * Scenarios * * @var boolean */ private $_scenarios; /** * Format cells * * @var boolean */ private $_formatCells; /** * Format columns * * @var boolean */ private $_formatColumns; /** * Format rows * * @var boolean */ private $_formatRows; /** * Insert columns * * @var boolean */ private $_insertColumns; /** * Insert rows * * @var boolean */ private $_insertRows; /** * Insert hyperlinks * * @var boolean */ private $_insertHyperlinks; /** * Delete columns * * @var boolean */ private $_deleteColumns; /** * Delete rows * * @var boolean */ private $_deleteRows; /** * Select locked cells * * @var boolean */ private $_selectLockedCells; /** * Sort * * @var boolean */ private $_sort; /** * AutoFilter * * @var boolean */ private $_autoFilter; /** * Pivot tables * * @var boolean */ private $_pivotTables; /** * Select unlocked cells * * @var boolean */ private $_selectUnlockedCells; /** * Password * * @var string */ private $_password; /** * Create a new PHPExcel_Worksheet_Protection */ public function __construct() { // Initialise values $this->_sheet = false; $this->_objects = false; $this->_scenarios = false; $this->_formatCells = false; $this->_formatColumns = false; $this->_formatRows = false; $this->_insertColumns = false; $this->_insertRows = false; $this->_insertHyperlinks = false; $this->_deleteColumns = false; $this->_deleteRows = false; $this->_selectLockedCells = false; $this->_sort = false; $this->_autoFilter = false; $this->_pivotTables = false; $this->_selectUnlockedCells = false; $this->_password = ''; } /** * Is some sort of protection enabled? * * @return boolean */ function isProtectionEnabled() { return $this->_sheet || $this->_objects || $this->_scenarios || $this->_formatCells || $this->_formatColumns || $this->_formatRows || $this->_insertColumns || $this->_insertRows || $this->_insertHyperlinks || $this->_deleteColumns || $this->_deleteRows || $this->_selectLockedCells || $this->_sort || $this->_autoFilter || $this->_pivotTables || $this->_selectUnlockedCells; } /** * Get Sheet * * @return boolean */ function getSheet() { return $this->_sheet; } /** * Set Sheet * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setSheet($pValue = false) { $this->_sheet = $pValue; return $this; } /** * Get Objects * * @return boolean */ function getObjects() { return $this->_objects; } /** * Set Objects * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setObjects($pValue = false) { $this->_objects = $pValue; return $this; } /** * Get Scenarios * * @return boolean */ function getScenarios() { return $this->_scenarios; } /** * Set Scenarios * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setScenarios($pValue = false) { $this->_scenarios = $pValue; return $this; } /** * Get FormatCells * * @return boolean */ function getFormatCells() { return $this->_formatCells; } /** * Set FormatCells * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setFormatCells($pValue = false) { $this->_formatCells = $pValue; return $this; } /** * Get FormatColumns * * @return boolean */ function getFormatColumns() { return $this->_formatColumns; } /** * Set FormatColumns * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setFormatColumns($pValue = false) { $this->_formatColumns = $pValue; return $this; } /** * Get FormatRows * * @return boolean */ function getFormatRows() { return $this->_formatRows; } /** * Set FormatRows * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setFormatRows($pValue = false) { $this->_formatRows = $pValue; return $this; } /** * Get InsertColumns * * @return boolean */ function getInsertColumns() { return $this->_insertColumns; } /** * Set InsertColumns * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setInsertColumns($pValue = false) { $this->_insertColumns = $pValue; return $this; } /** * Get InsertRows * * @return boolean */ function getInsertRows() { return $this->_insertRows; } /** * Set InsertRows * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setInsertRows($pValue = false) { $this->_insertRows = $pValue; return $this; } /** * Get InsertHyperlinks * * @return boolean */ function getInsertHyperlinks() { return $this->_insertHyperlinks; } /** * Set InsertHyperlinks * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setInsertHyperlinks($pValue = false) { $this->_insertHyperlinks = $pValue; return $this; } /** * Get DeleteColumns * * @return boolean */ function getDeleteColumns() { return $this->_deleteColumns; } /** * Set DeleteColumns * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setDeleteColumns($pValue = false) { $this->_deleteColumns = $pValue; return $this; } /** * Get DeleteRows * * @return boolean */ function getDeleteRows() { return $this->_deleteRows; } /** * Set DeleteRows * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setDeleteRows($pValue = false) { $this->_deleteRows = $pValue; return $this; } /** * Get SelectLockedCells * * @return boolean */ function getSelectLockedCells() { return $this->_selectLockedCells; } /** * Set SelectLockedCells * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setSelectLockedCells($pValue = false) { $this->_selectLockedCells = $pValue; return $this; } /** * Get Sort * * @return boolean */ function getSort() { return $this->_sort; } /** * Set Sort * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setSort($pValue = false) { $this->_sort = $pValue; return $this; } /** * Get AutoFilter * * @return boolean */ function getAutoFilter() { return $this->_autoFilter; } /** * Set AutoFilter * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setAutoFilter($pValue = false) { $this->_autoFilter = $pValue; return $this; } /** * Get PivotTables * * @return boolean */ function getPivotTables() { return $this->_pivotTables; } /** * Set PivotTables * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setPivotTables($pValue = false) { $this->_pivotTables = $pValue; return $this; } /** * Get SelectUnlockedCells * * @return boolean */ function getSelectUnlockedCells() { return $this->_selectUnlockedCells; } /** * Set SelectUnlockedCells * * @param boolean $pValue * @return PHPExcel_Worksheet_Protection */ function setSelectUnlockedCells($pValue = false) { $this->_selectUnlockedCells = $pValue; return $this; } /** * Get Password (hashed) * * @return string */ function getPassword() { return $this->_password; } /** * Set Password * * @param string $pValue * @param boolean $pAlreadyHashed If the password has already been hashed, set this to true * @return PHPExcel_Worksheet_Protection */ function setPassword($pValue = '', $pAlreadyHashed = false) { if (!$pAlreadyHashed) { $pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue); } $this->_password = $pValue; return $this; } /** * 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)) { $this->$key = clone $value; } else { $this->$key = $value; } } } } Documentation generated on Mon, 11 Jan 2010 08:13:05 +0100 by phpDocumentor 1.4.1