PhpOffice\PhpSpreadsheet\Document\Security Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Document\Security:

Public Member Functions
	__construct ()
	Create a new Document Security instance. More...
	isSecurityEnabled ()
	Is some sort of document security enabled? More...
	getLockRevision ()
	setLockRevision (?bool $pValue)
	getLockStructure ()
	setLockStructure (?bool $pValue)
	getLockWindows ()
	setLockWindows (?bool $pValue)
	getRevisionsPassword ()
	setRevisionsPassword (?string $pValue, bool $pAlreadyHashed=false)
	getWorkbookPassword ()
	setWorkbookPassword (?string $pValue, bool $pAlreadyHashed=false)

Private Attributes
	$lockRevision = false
	$lockStructure = false
	$lockWindows = false
	$revisionsPassword = ''
	$workbookPassword = ''

Detailed Description

Definition at line 7 of file Security.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Document\Security::__construct

(

)

Create a new Document Security instance.

Definition at line 47 of file Security.php.

    {
    }

Member Function Documentation

getLockRevision()

PhpOffice\PhpSpreadsheet\Document\Security::getLockRevision

(

)

Definition at line 61 of file Security.php.

References PhpOffice\PhpSpreadsheet\Document\Security\$lockRevision.

                                     : bool
    {
        return $this->lockRevision;
    }

getLockStructure()

PhpOffice\PhpSpreadsheet\Document\Security::getLockStructure

(

)

Definition at line 75 of file Security.php.

References PhpOffice\PhpSpreadsheet\Document\Security\$lockStructure.

                                      : bool
    {
        return $this->lockStructure;
    }

getLockWindows()

PhpOffice\PhpSpreadsheet\Document\Security::getLockWindows

(

)

Definition at line 89 of file Security.php.

References PhpOffice\PhpSpreadsheet\Document\Security\$lockWindows.

                                    : bool
    {
        return $this->lockWindows;
    }

getRevisionsPassword()

PhpOffice\PhpSpreadsheet\Document\Security::getRevisionsPassword

(

)

Definition at line 103 of file Security.php.

References PhpOffice\PhpSpreadsheet\Document\Security\$revisionsPassword.

                                          : string
    {
        return $this->revisionsPassword;
    }

getWorkbookPassword()

PhpOffice\PhpSpreadsheet\Document\Security::getWorkbookPassword

(

)

Definition at line 120 of file Security.php.

References PhpOffice\PhpSpreadsheet\Document\Security\$workbookPassword.

                                         : string
    {
        return $this->workbookPassword;
    }

isSecurityEnabled()

PhpOffice\PhpSpreadsheet\Document\Security::isSecurityEnabled

(

)

Is some sort of document security enabled?

Definition at line 54 of file Security.php.

References PhpOffice\PhpSpreadsheet\Document\Security\$lockWindows.

                                       : bool
    {
        return  $this->lockRevision ||
                $this->lockStructure ||
                $this->lockWindows;
    }

setLockRevision()

PhpOffice\PhpSpreadsheet\Document\Security::setLockRevision

(

?bool

$pValue

)

Definition at line 66 of file Security.php.

                                                  : self
    {
        if ($pValue !== null) {
            $this->lockRevision = $pValue;
        }

        return $this;
    }

setLockStructure()

PhpOffice\PhpSpreadsheet\Document\Security::setLockStructure

(

?bool

$pValue

)

Definition at line 80 of file Security.php.

                                                   : self
    {
        if ($pValue !== null) {
            $this->lockStructure = $pValue;
        }

        return $this;
    }

setLockWindows()

PhpOffice\PhpSpreadsheet\Document\Security::setLockWindows

(

?bool

$pValue

)

Definition at line 94 of file Security.php.

                                                 : self
    {
        if ($pValue !== null) {
            $this->lockWindows = $pValue;
        }

        return $this;
    }

setRevisionsPassword()

PhpOffice\PhpSpreadsheet\Document\Security::setRevisionsPassword	(	?string	$pValue,
		bool	$pAlreadyHashed = false
	)

Definition at line 108 of file Security.php.

References PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\hashPassword().

                                                                                       : self
    {
        if ($pValue !== null) {
            if (!$pAlreadyHashed) {
                $pValue = PasswordHasher::hashPassword($pValue);
            }
            $this->revisionsPassword = $pValue;
        }

        return $this;
    }

Here is the call graph for this function:

setWorkbookPassword()

PhpOffice\PhpSpreadsheet\Document\Security::setWorkbookPassword	(	?string	$pValue,
		bool	$pAlreadyHashed = false
	)

Definition at line 125 of file Security.php.

References PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\hashPassword().

                                                                                      : self
    {
        if ($pValue !== null) {
            if (!$pAlreadyHashed) {
                $pValue = PasswordHasher::hashPassword($pValue);
            }
            $this->workbookPassword = $pValue;
        }

        return $this;
    }

Here is the call graph for this function:

Field Documentation

$lockRevision

PhpOffice\PhpSpreadsheet\Document\Security::$lockRevision = false

private

Definition at line 14 of file Security.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Security\getLockRevision().

$lockStructure

PhpOffice\PhpSpreadsheet\Document\Security::$lockStructure = false

private

Definition at line 21 of file Security.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Security\getLockStructure().

$lockWindows

PhpOffice\PhpSpreadsheet\Document\Security::$lockWindows = false

private

Definition at line 28 of file Security.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Security\getLockWindows(), and PhpOffice\PhpSpreadsheet\Document\Security\isSecurityEnabled().

$revisionsPassword

PhpOffice\PhpSpreadsheet\Document\Security::$revisionsPassword = ''

private

Definition at line 35 of file Security.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Security\getRevisionsPassword().

$workbookPassword

PhpOffice\PhpSpreadsheet\Document\Security::$workbookPassword = ''

private

Definition at line 42 of file Security.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Security\getWorkbookPassword().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Document/Security.php