PHPExcel_DocumentSecurity Class Reference

Collaboration diagram for PHPExcel_DocumentSecurity:

Public Member Functions
	__construct ()
	Create a new PHPExcel_DocumentSecurity. More...
	isSecurityEnabled ()
	Is some sort of dcument security enabled? More...
	getLockRevision ()
	Get LockRevision. More...
	setLockRevision ($pValue=false)
	Set LockRevision. More...
	getLockStructure ()
	Get LockStructure. More...
	setLockStructure ($pValue=false)
	Set LockStructure. More...
	getLockWindows ()
	Get LockWindows. More...
	setLockWindows ($pValue=false)
	Set LockWindows. More...
	getRevisionsPassword ()
	Get RevisionsPassword (hashed) More...
	setRevisionsPassword ($pValue='', $pAlreadyHashed=false)
	Set RevisionsPassword. More...
	getWorkbookPassword ()
	Get WorkbookPassword (hashed) More...
	setWorkbookPassword ($pValue='', $pAlreadyHashed=false)
	Set WorkbookPassword. More...
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

Private Attributes
	$_lockRevision
	$_lockStructure
	$_lockWindows
	$_revisionsPassword
	$_workbookPassword

Detailed Description

Definition at line 36 of file DocumentSecurity.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_DocumentSecurity::__construct

(

)

Create a new PHPExcel_DocumentSecurity.

Definition at line 76 of file DocumentSecurity.php.

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

Member Function Documentation

__clone()

PHPExcel_DocumentSecurity::__clone

(

)

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 208 of file DocumentSecurity.php.

References $key.

                                  {
                $vars = get_object_vars($this);
                foreach ($vars as $key => $value) {
                        if (is_object($value)) {
                                $this->$key = clone $value;
                        } else {
                                $this->$key = $value;
                        }
                }
        }

getLockRevision()

PHPExcel_DocumentSecurity::getLockRevision

(

)

Get LockRevision.

Returns

boolean

Definition at line 102 of file DocumentSecurity.php.

References $_lockRevision.

                               {
        return $this->_lockRevision;
    }

getLockStructure()

PHPExcel_DocumentSecurity::getLockStructure

(

)

Get LockStructure.

Returns

boolean

Definition at line 122 of file DocumentSecurity.php.

References $_lockStructure.

                                {
        return $this->_lockStructure;
    }

getLockWindows()

PHPExcel_DocumentSecurity::getLockWindows

(

)

Get LockWindows.

Returns

boolean

Definition at line 142 of file DocumentSecurity.php.

References $_lockWindows.

                              {
        return $this->_lockWindows;
    }

getRevisionsPassword()

PHPExcel_DocumentSecurity::getRevisionsPassword

(

)

Get RevisionsPassword (hashed)

Returns

string

Definition at line 162 of file DocumentSecurity.php.

References $_revisionsPassword.

                                    {
        return $this->_revisionsPassword;
    }

getWorkbookPassword()

PHPExcel_DocumentSecurity::getWorkbookPassword

(

)

Get WorkbookPassword (hashed)

Returns

string

Definition at line 186 of file DocumentSecurity.php.

References $_workbookPassword.

                                   {
        return $this->_workbookPassword;
    }

isSecurityEnabled()

PHPExcel_DocumentSecurity::isSecurityEnabled

(

)

Is some sort of dcument security enabled?

Returns

boolean

Definition at line 91 of file DocumentSecurity.php.

References $_lockWindows.

                                 {
        return  $this->_lockRevision ||
                        $this->_lockStructure ||
                        $this->_lockWindows;
    }

setLockRevision()

PHPExcel_DocumentSecurity::setLockRevision

(

$pValue = false

)

Set LockRevision.

Parameters

boolean

$pValue

Returns

PHPExcel_DocumentSecurity

Definition at line 112 of file DocumentSecurity.php.

                                              {
        $this->_lockRevision = $pValue;
        return $this;
    }

setLockStructure()

PHPExcel_DocumentSecurity::setLockStructure

(

$pValue = false

)

Set LockStructure.

Parameters

boolean

$pValue

Returns

PHPExcel_DocumentSecurity

Definition at line 132 of file DocumentSecurity.php.

                                               {
                $this->_lockStructure = $pValue;
                return $this;
    }

setLockWindows()

PHPExcel_DocumentSecurity::setLockWindows

(

$pValue = false

)

Set LockWindows.

Parameters

boolean

$pValue

Returns

PHPExcel_DocumentSecurity

Definition at line 152 of file DocumentSecurity.php.

                                             {
        $this->_lockWindows = $pValue;
        return $this;
    }

setRevisionsPassword()

PHPExcel_DocumentSecurity::setRevisionsPassword	(		$pValue = '',
			$pAlreadyHashed = false
	)

Set RevisionsPassword.

Parameters

string	$pValue
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

Returns

PHPExcel_DocumentSecurity

Definition at line 173 of file DocumentSecurity.php.

References PHPExcel_Shared_PasswordHasher\hashPassword().

                                                                         {
        if (!$pAlreadyHashed) {
                $pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue);
        }
        $this->_revisionsPassword = $pValue;
        return $this;
    }

Here is the call graph for this function:

setWorkbookPassword()

PHPExcel_DocumentSecurity::setWorkbookPassword	(		$pValue = '',
			$pAlreadyHashed = false
	)

Set WorkbookPassword.

Parameters

string	$pValue
boolean	$pAlreadyHashed	If the password has already been hashed, set this to true

Returns

PHPExcel_DocumentSecurity

Definition at line 197 of file DocumentSecurity.php.

References PHPExcel_Shared_PasswordHasher\hashPassword().

                                                                        {
        if (!$pAlreadyHashed) {
                $pValue = PHPExcel_Shared_PasswordHasher::hashPassword($pValue);
        }
                $this->_workbookPassword = $pValue;
                return $this;
    }

Here is the call graph for this function:

Field Documentation

$_lockRevision

PHPExcel_DocumentSecurity::$_lockRevision

private

Definition at line 43 of file DocumentSecurity.php.

Referenced by getLockRevision().

$_lockStructure

PHPExcel_DocumentSecurity::$_lockStructure

private

Definition at line 50 of file DocumentSecurity.php.

Referenced by getLockStructure().

$_lockWindows

PHPExcel_DocumentSecurity::$_lockWindows

private

Definition at line 57 of file DocumentSecurity.php.

Referenced by getLockWindows(), and isSecurityEnabled().

$_revisionsPassword

PHPExcel_DocumentSecurity::$_revisionsPassword

private

Definition at line 64 of file DocumentSecurity.php.

Referenced by getRevisionsPassword().

$_workbookPassword

PHPExcel_DocumentSecurity::$_workbookPassword

private

Definition at line 71 of file DocumentSecurity.php.

Referenced by getWorkbookPassword().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/DocumentSecurity.php