class PHPExcel_DocumentSecurity in Loft Data Grids 7.2

PHPExcel_DocumentSecurity

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

Hierarchy

• class \PHPExcel_DocumentSecurity

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/DocumentSecurity.php, line 36

class PHPExcel_DocumentSecurity {

  /**
   * LockRevision
   *
   * @var boolean
   */
  private $_lockRevision;

  /**
   * LockStructure
   *
   * @var boolean
   */
  private $_lockStructure;

  /**
   * LockWindows
   *
   * @var boolean
   */
  private $_lockWindows;

  /**
   * RevisionsPassword
   *
   * @var string
   */
  private $_revisionsPassword;

  /**
   * WorkbookPassword
   *
   * @var string
   */
  private $_workbookPassword;

  /**
   * Create a new PHPExcel_DocumentSecurity
   */
  public function __construct() {

    // Initialise values
    $this->_lockRevision = false;
    $this->_lockStructure = false;
    $this->_lockWindows = false;
    $this->_revisionsPassword = '';
    $this->_workbookPassword = '';
  }

  /**
   * Is some sort of dcument security enabled?
   *
   * @return boolean
   */
  function isSecurityEnabled() {
    return $this->_lockRevision || $this->_lockStructure || $this->_lockWindows;
  }

  /**
   * Get LockRevision
   *
   * @return boolean
   */
  function getLockRevision() {
    return $this->_lockRevision;
  }

  /**
   * Set LockRevision
   *
   * @param boolean $pValue
   * @return PHPExcel_DocumentSecurity
   */
  function setLockRevision($pValue = false) {
    $this->_lockRevision = $pValue;
    return $this;
  }

  /**
   * Get LockStructure
   *
   * @return boolean
   */
  function getLockStructure() {
    return $this->_lockStructure;
  }

  /**
   * Set LockStructure
   *
   * @param boolean $pValue
   * @return PHPExcel_DocumentSecurity
   */
  function setLockStructure($pValue = false) {
    $this->_lockStructure = $pValue;
    return $this;
  }

  /**
   * Get LockWindows
   *
   * @return boolean
   */
  function getLockWindows() {
    return $this->_lockWindows;
  }

  /**
   * Set LockWindows
   *
   * @param boolean $pValue
   * @return PHPExcel_DocumentSecurity
   */
  function setLockWindows($pValue = false) {
    $this->_lockWindows = $pValue;
    return $this;
  }

  /**
   * Get RevisionsPassword (hashed)
   *
   * @return string
   */
  function getRevisionsPassword() {
    return $this->_revisionsPassword;
  }

  /**
   * Set RevisionsPassword
   *
   * @param string 	$pValue
   * @param boolean 	$pAlreadyHashed If the password has already been hashed, set this to true
   * @return PHPExcel_DocumentSecurity
   */
  function setRevisionsPassword($pValue = '', $pAlreadyHashed = false) {
    if (!$pAlreadyHashed) {
      $pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue);
    }
    $this->_revisionsPassword = $pValue;
    return $this;
  }

  /**
   * Get WorkbookPassword (hashed)
   *
   * @return string
   */
  function getWorkbookPassword() {
    return $this->_workbookPassword;
  }

  /**
   * Set WorkbookPassword
   *
   * @param string 	$pValue
   * @param boolean 	$pAlreadyHashed If the password has already been hashed, set this to true
   * @return PHPExcel_DocumentSecurity
   */
  function setWorkbookPassword($pValue = '', $pAlreadyHashed = false) {
    if (!$pAlreadyHashed) {
      $pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue);
    }
    $this->_workbookPassword = $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;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_DocumentSecurity::$_lockRevision	private	property	* LockRevision * *
PHPExcel_DocumentSecurity::$_lockStructure	private	property	* LockStructure * *
PHPExcel_DocumentSecurity::$_lockWindows	private	property	* LockWindows * *
PHPExcel_DocumentSecurity::$_revisionsPassword	private	property	* RevisionsPassword * *
PHPExcel_DocumentSecurity::$_workbookPassword	private	property	* WorkbookPassword * *
PHPExcel_DocumentSecurity::getLockRevision		function	Get LockRevision
PHPExcel_DocumentSecurity::getLockStructure		function	Get LockStructure
PHPExcel_DocumentSecurity::getLockWindows		function	Get LockWindows
PHPExcel_DocumentSecurity::getRevisionsPassword		function	Get RevisionsPassword (hashed)
PHPExcel_DocumentSecurity::getWorkbookPassword		function	Get WorkbookPassword (hashed)
PHPExcel_DocumentSecurity::isSecurityEnabled		function	Is some sort of dcument security enabled?
PHPExcel_DocumentSecurity::setLockRevision		function	Set LockRevision
PHPExcel_DocumentSecurity::setLockStructure		function	Set LockStructure
PHPExcel_DocumentSecurity::setLockWindows		function	Set LockWindows
PHPExcel_DocumentSecurity::setRevisionsPassword		function	Set RevisionsPassword
PHPExcel_DocumentSecurity::setWorkbookPassword		function	Set WorkbookPassword
PHPExcel_DocumentSecurity::__clone	public	function	* Implement PHP __clone to create a deep clone, not just a shallow copy.
PHPExcel_DocumentSecurity::__construct	public	function	Create a new PHPExcel_DocumentSecurity