Collaboration diagram for PHPExcel_DocumentSecurity:

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

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

Detailed Description

Definition at line 36 of file DocumentSecurity.php.

Constructor & Destructor Documentation

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

PHPExcel_DocumentSecurity::__clone ( )

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

Definition at line 208 of file DocumentSecurity.php.

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

PHPExcel_DocumentSecurity::getLockRevision ( )

Get LockRevision.

Returns: boolean

Definition at line 102 of file DocumentSecurity.php.

References $_lockRevision.

                               {
        return $this->_lockRevision;
    }

PHPExcel_DocumentSecurity::getLockStructure ( )

Get LockStructure.

Returns: boolean

Definition at line 122 of file DocumentSecurity.php.

References $_lockStructure.

                                {
        return $this->_lockStructure;
    }

PHPExcel_DocumentSecurity::getLockWindows ( )

Get LockWindows.

Returns: boolean

Definition at line 142 of file DocumentSecurity.php.

References $_lockWindows.

                              {
        return $this->_lockWindows;
    }

PHPExcel_DocumentSecurity::getRevisionsPassword ( )

Get RevisionsPassword (hashed)

Returns: string

Definition at line 162 of file DocumentSecurity.php.

References $_revisionsPassword.

                                    {
        return $this->_revisionsPassword;
    }

PHPExcel_DocumentSecurity::getWorkbookPassword ( )

Get WorkbookPassword (hashed)

Returns: string

Definition at line 186 of file DocumentSecurity.php.

References $_workbookPassword.

                                   {
        return $this->_workbookPassword;
    }

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;
    }

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;
    }

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;
    }

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;
    }

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:

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;
    }