Collaboration diagram for PhpOffice\PhpSpreadsheet\Worksheet\Protection:

Public Member Functions
	__construct ()
	Create a new Protection. More...

	isProtectionEnabled ()
	Is some sort of protection enabled? More...

	getSheet ()
	Get Sheet. More...

	setSheet ($pValue)
	Set Sheet. More...

	getObjects ()
	Get Objects. More...

	setObjects ($pValue)
	Set Objects. More...

	getScenarios ()
	Get Scenarios. More...

	setScenarios ($pValue)
	Set Scenarios. More...

	getFormatCells ()
	Get FormatCells. More...

	setFormatCells ($pValue)
	Set FormatCells. More...

	getFormatColumns ()
	Get FormatColumns. More...

	setFormatColumns ($pValue)
	Set FormatColumns. More...

	getFormatRows ()
	Get FormatRows. More...

	setFormatRows ($pValue)
	Set FormatRows. More...

	getInsertColumns ()
	Get InsertColumns. More...

	setInsertColumns ($pValue)
	Set InsertColumns. More...

	getInsertRows ()
	Get InsertRows. More...

	setInsertRows ($pValue)
	Set InsertRows. More...

	getInsertHyperlinks ()
	Get InsertHyperlinks. More...

	setInsertHyperlinks ($pValue)
	Set InsertHyperlinks. More...

	getDeleteColumns ()
	Get DeleteColumns. More...

	setDeleteColumns ($pValue)
	Set DeleteColumns. More...

	getDeleteRows ()
	Get DeleteRows. More...

	setDeleteRows ($pValue)
	Set DeleteRows. More...

	getSelectLockedCells ()
	Get SelectLockedCells. More...

	setSelectLockedCells ($pValue)
	Set SelectLockedCells. More...

	getSort ()
	Get Sort. More...

	setSort ($pValue)
	Set Sort. More...

	getAutoFilter ()
	Get AutoFilter. More...

	setAutoFilter ($pValue)
	Set AutoFilter. More...

	getPivotTables ()
	Get PivotTables. More...

	setPivotTables ($pValue)
	Set PivotTables. More...

	getSelectUnlockedCells ()
	Get SelectUnlockedCells. More...

	setSelectUnlockedCells ($pValue)
	Set SelectUnlockedCells. More...

	getPassword ()
	Get hashed password. More...

	setPassword ($pValue, $pAlreadyHashed=false)
	Set Password. More...

	getAlgorithm ()
	Get algorithm name. More...

	setAlgorithm (string $algorithm)
	Set algorithm name. More...

	getSalt ()
	Get salt value. More...

	setSalt (string $salt)
	Set salt value. More...

	getSpinCount ()
	Get spin count. More...

	setSpinCount (int $spinCount)
	Set spin count. More...

	verify (string $password)
	Verify that the given non-hashed password can "unlock" the protection. More...

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

Data Fields
const	ALGORITHM_MD2 = 'MD2'

const	ALGORITHM_MD4 = 'MD4'

const	ALGORITHM_MD5 = 'MD5'

const	ALGORITHM_SHA_1 = 'SHA-1'

const	ALGORITHM_SHA_256 = 'SHA-256'

const	ALGORITHM_SHA_384 = 'SHA-384'

const	ALGORITHM_SHA_512 = 'SHA-512'

const	ALGORITHM_RIPEMD_128 = 'RIPEMD-128'

const	ALGORITHM_RIPEMD_160 = 'RIPEMD-160'

const	ALGORITHM_WHIRLPOOL = 'WHIRLPOOL'

Private Member Functions
	generateSalt ()
	Create a pseudorandom string. More...

Private Attributes
	$sheet = false

	$objects = false

	$scenarios = false

	$formatCells = false

	$formatColumns = false

	$formatRows = false

	$insertColumns = false

	$insertRows = false

	$insertHyperlinks = false

	$deleteColumns = false

	$deleteRows = false

	$selectLockedCells = false

	$sort = false

	$autoFilter = false

	$pivotTables = false

	$selectUnlockedCells = false

	$password = ''

	$algorithm = ''

	$salt = ''

	$spinCount = 10000

Detailed Description

Definition at line 7 of file Protection.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::__construct ( )

Create a new Protection.

Definition at line 163 of file Protection.php.

164 {

165 }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::__clone ( )

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

Definition at line 680 of file Protection.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;
             }
         }
     }

◆ generateSalt()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::generateSalt ( )

private

Create a pseudorandom string.

Definition at line 610 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword().

                                    : string
     {
         return base64_encode(random_bytes(16));
     }

Here is the caller graph for this function:

◆ getAlgorithm()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getAlgorithm ( )

Get algorithm name.

Definition at line 618 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$algorithm.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\verify().

                                   : string
     {
         return $this->algorithm;
     }

Here is the caller graph for this function:

◆ getAutoFilter()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getAutoFilter ( )

Get AutoFilter.

Returns: bool

Definition at line 509 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$autoFilter.

     {
         return $this->autoFilter;
     }

◆ getDeleteColumns()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getDeleteColumns ( )

Get DeleteColumns.

Returns: bool

Definition at line 413 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$deleteColumns.

     {
         return $this->deleteColumns;
     }

◆ getDeleteRows()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getDeleteRows ( )

Get DeleteRows.

Returns: bool

Definition at line 437 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$deleteRows.

     {
         return $this->deleteRows;
     }

◆ getFormatCells()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getFormatCells ( )

Get FormatCells.

Returns: bool

Definition at line 269 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$formatCells.

     {
         return $this->formatCells;
     }

◆ getFormatColumns()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getFormatColumns ( )

Get FormatColumns.

Returns: bool

Definition at line 293 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$formatColumns.

     {
         return $this->formatColumns;
     }

◆ getFormatRows()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getFormatRows ( )

Get FormatRows.

Returns: bool

Definition at line 317 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$formatRows.

     {
         return $this->formatRows;
     }

◆ getInsertColumns()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getInsertColumns ( )

Get InsertColumns.

Returns: bool

Definition at line 341 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$insertColumns.

     {
         return $this->insertColumns;
     }

◆ getInsertHyperlinks()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getInsertHyperlinks ( )

Get InsertHyperlinks.

Returns: bool

Definition at line 389 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$insertHyperlinks.

     {
         return $this->insertHyperlinks;
     }

◆ getInsertRows()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getInsertRows ( )

Get InsertRows.

Returns: bool

Definition at line 365 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$insertRows.

     {
         return $this->insertRows;
     }

◆ getObjects()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getObjects ( )

Get Objects.

Returns: bool

Definition at line 221 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$objects.

     {
         return $this->objects;
     }

◆ getPassword()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getPassword ( )

Get hashed password.

Returns: string

Definition at line 581 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$password.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\verify().

     {
         return $this->password;
     }

Here is the caller graph for this function:

◆ getPivotTables()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getPivotTables ( )

Get PivotTables.

Returns: bool

Definition at line 533 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$pivotTables.

     {
         return $this->pivotTables;
     }

◆ getSalt()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getSalt ( )

Get salt value.

Definition at line 634 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$salt.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\verify().

                              : string
     {
         return $this->salt;
     }

Here is the caller graph for this function:

◆ getScenarios()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getScenarios ( )

Get Scenarios.

Returns: bool

Definition at line 245 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$scenarios.

     {
         return $this->scenarios;
     }

◆ getSelectLockedCells()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getSelectLockedCells ( )

Get SelectLockedCells.

Returns: bool

Definition at line 461 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$selectLockedCells.

     {
         return $this->selectLockedCells;
     }

◆ getSelectUnlockedCells()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getSelectUnlockedCells ( )

Get SelectUnlockedCells.

Returns: bool

Definition at line 557 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$selectUnlockedCells.

     {
         return $this->selectUnlockedCells;
     }

◆ getSheet()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getSheet ( )

Get Sheet.

Returns: bool

Definition at line 197 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$sheet.

     {
         return $this->sheet;
     }

◆ getSort()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getSort ( )

Get Sort.

Returns: bool

Definition at line 485 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$sort.

     {
         return $this->sort;
     }

◆ getSpinCount()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::getSpinCount ( )

Get spin count.

Definition at line 650 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$spinCount.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\verify().

                                   : int
     {
         return $this->spinCount;
     }

Here is the caller graph for this function:

◆ isProtectionEnabled()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::isProtectionEnabled ( )

Is some sort of protection enabled?

Returns: bool

Definition at line 172 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$selectUnlockedCells.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\verify().

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

Here is the caller graph for this function:

◆ setAlgorithm()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setAlgorithm ( string $algorithm )

Set algorithm name.

Definition at line 626 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$algorithm.

                                                    : void
     {
         $this->algorithm = $algorithm;
     }

◆ setAutoFilter()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setAutoFilter ( $pValue )

Set AutoFilter.

Parameters

bool $pValue

Returns: $this

Definition at line 521 of file Protection.php.

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

◆ setDeleteColumns()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setDeleteColumns ( $pValue )

Set DeleteColumns.

Parameters

bool $pValue

Returns: $this

Definition at line 425 of file Protection.php.

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

◆ setDeleteRows()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setDeleteRows ( $pValue )

Set DeleteRows.

Parameters

bool $pValue

Returns: $this

Definition at line 449 of file Protection.php.

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

◆ setFormatCells()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setFormatCells ( $pValue )

Set FormatCells.

Parameters

bool $pValue

Returns: $this

Definition at line 281 of file Protection.php.

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

◆ setFormatColumns()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setFormatColumns ( $pValue )

Set FormatColumns.

Parameters

bool $pValue

Returns: $this

Definition at line 305 of file Protection.php.

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

◆ setFormatRows()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setFormatRows ( $pValue )

Set FormatRows.

Parameters

bool $pValue

Returns: $this

Definition at line 329 of file Protection.php.

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

◆ setInsertColumns()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setInsertColumns ( $pValue )

Set InsertColumns.

Parameters

bool $pValue

Returns: $this

Definition at line 353 of file Protection.php.

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

◆ setInsertHyperlinks()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setInsertHyperlinks ( $pValue )

Set InsertHyperlinks.

Parameters

bool $pValue

Returns: $this

Definition at line 401 of file Protection.php.

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

◆ setInsertRows()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setInsertRows ( $pValue )

Set InsertRows.

Parameters

bool $pValue

Returns: $this

Definition at line 377 of file Protection.php.

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

◆ setObjects()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setObjects ( $pValue )

Set Objects.

Parameters

bool $pValue

Returns: $this

Definition at line 233 of file Protection.php.

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

◆ setPassword()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setPassword	(	$pValue,
		$pAlreadyHashed = `false`
	)

Set Password.

Parameters

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

Returns: $this

Definition at line 594 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$salt, PhpOffice\PhpSpreadsheet\Worksheet\Protection\generateSalt(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\getAlgorithm(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSalt(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSpinCount(), PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\hashPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\setSalt().

     {
         if (!$pAlreadyHashed) {
             $salt = $this->generateSalt();
             $this->setSalt($salt);
             $pValue = PasswordHasher::hashPassword($pValue, $this->getAlgorithm(), $this->getSalt(), $this->getSpinCount());
         }
 
         $this->password = $pValue;
 
         return $this;
     }

Here is the call graph for this function:

◆ setPivotTables()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setPivotTables ( $pValue )

Set PivotTables.

Parameters

bool $pValue

Returns: $this

Definition at line 545 of file Protection.php.

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

◆ setSalt()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setSalt ( string $salt )

Set salt value.

Definition at line 642 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$salt.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword().

                                          : void
     {
         $this->salt = $salt;
     }

Here is the caller graph for this function:

◆ setScenarios()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setScenarios ( $pValue )

Set Scenarios.

Parameters

bool $pValue

Returns: $this

Definition at line 257 of file Protection.php.

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

◆ setSelectLockedCells()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setSelectLockedCells ( $pValue )

Set SelectLockedCells.

Parameters

bool $pValue

Returns: $this

Definition at line 473 of file Protection.php.

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

◆ setSelectUnlockedCells()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setSelectUnlockedCells ( $pValue )

Set SelectUnlockedCells.

Parameters

bool $pValue

Returns: $this

Definition at line 569 of file Protection.php.

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

◆ setSheet()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setSheet ( $pValue )

Set Sheet.

Parameters

bool $pValue

Returns: $this

Definition at line 209 of file Protection.php.

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

◆ setSort()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setSort ( $pValue )

Set Sort.

Parameters

bool $pValue

Returns: $this

Definition at line 497 of file Protection.php.

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

◆ setSpinCount()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::setSpinCount ( int $spinCount )

Set spin count.

Definition at line 658 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\$spinCount.

                                                 : void
     {
         $this->spinCount = $spinCount;
     }

◆ verify()

PhpOffice\PhpSpreadsheet\Worksheet\Protection::verify ( string $password )

Verify that the given non-hashed password can "unlock" the protection.

Definition at line 666 of file Protection.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\$hash, PhpOffice\PhpSpreadsheet\Worksheet\Protection\getAlgorithm(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\getPassword(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSalt(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSpinCount(), PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\hashPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\isProtectionEnabled().

                                             : bool
     {
         if (!$this->isProtectionEnabled()) {
             return true;
         }
 
         $hash = PasswordHasher::hashPassword($password, $this->getAlgorithm(), $this->getSalt(), $this->getSpinCount());
 
         return $this->getPassword() === $hash;
     }

Here is the call graph for this function:

Field Documentation

◆ $algorithm

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$algorithm = ''

private

Definition at line 144 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getAlgorithm(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\setAlgorithm().

◆ $autoFilter

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$autoFilter = false

private

Definition at line 116 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getAutoFilter().

◆ $deleteColumns

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$deleteColumns = false

private

Definition at line 88 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getDeleteColumns().

◆ $deleteRows

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$deleteRows = false

private

Definition at line 95 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getDeleteRows().

◆ $formatCells

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$formatCells = false

private

Definition at line 46 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getFormatCells().

◆ $formatColumns

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$formatColumns = false

private

Definition at line 53 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getFormatColumns().

◆ $formatRows

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$formatRows = false

private

Definition at line 60 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getFormatRows().

◆ $insertColumns

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$insertColumns = false

private

Definition at line 67 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getInsertColumns().

◆ $insertHyperlinks

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$insertHyperlinks = false

private

Definition at line 81 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getInsertHyperlinks().

◆ $insertRows

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$insertRows = false

private

Definition at line 74 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getInsertRows().

◆ $objects

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$objects = false

private

Definition at line 32 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getObjects().

◆ $password

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$password = ''

private

Definition at line 137 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getPassword().

◆ $pivotTables

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$pivotTables = false

private

Definition at line 123 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getPivotTables().

◆ $salt

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$salt = ''

private

Definition at line 151 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSalt(), PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\setSalt().

◆ $scenarios

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$scenarios = false

private

Definition at line 39 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getScenarios().

◆ $selectLockedCells

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$selectLockedCells = false

private

Definition at line 102 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSelectLockedCells().

◆ $selectUnlockedCells

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$selectUnlockedCells = false

private

Definition at line 130 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSelectUnlockedCells(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\isProtectionEnabled().

◆ $sheet

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$sheet = false

private

Definition at line 25 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSheet().

◆ $sort

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$sort = false

private

Definition at line 109 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSort().

◆ $spinCount

PhpOffice\PhpSpreadsheet\Worksheet\Protection::$spinCount = 10000

private

Definition at line 158 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\getSpinCount(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\setSpinCount().

◆ ALGORITHM_MD2

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_MD2 = 'MD2'

Definition at line 9 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_MD4

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_MD4 = 'MD4'

Definition at line 10 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_MD5

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_MD5 = 'MD5'

Definition at line 11 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_RIPEMD_128

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_RIPEMD_128 = 'RIPEMD-128'

Definition at line 16 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_RIPEMD_160

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_RIPEMD_160 = 'RIPEMD-160'

Definition at line 17 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_SHA_1

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_SHA_1 = 'SHA-1'

Definition at line 12 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_SHA_256

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_SHA_256 = 'SHA-256'

Definition at line 13 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_SHA_384

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_SHA_384 = 'SHA-384'

Definition at line 14 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_SHA_512

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_SHA_512 = 'SHA-512'

Definition at line 15 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

◆ ALGORITHM_WHIRLPOOL

const PhpOffice\PhpSpreadsheet\Worksheet\Protection::ALGORITHM_WHIRLPOOL = 'WHIRLPOOL'

Definition at line 18 of file Protection.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/Protection.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ generateSalt()

◆ getAlgorithm()

◆ getAutoFilter()

◆ getDeleteColumns()

◆ getDeleteRows()

◆ getFormatCells()

◆ getFormatColumns()

◆ getFormatRows()

◆ getInsertColumns()

◆ getInsertHyperlinks()

◆ getInsertRows()

◆ getObjects()

◆ getPassword()

◆ getPivotTables()

◆ getSalt()

◆ getScenarios()

◆ getSelectLockedCells()

◆ getSelectUnlockedCells()

◆ getSheet()

◆ getSort()

◆ getSpinCount()

◆ isProtectionEnabled()

◆ setAlgorithm()

◆ setAutoFilter()

◆ setDeleteColumns()

◆ setDeleteRows()

◆ setFormatCells()

◆ setFormatColumns()

◆ setFormatRows()

◆ setInsertColumns()

◆ setInsertHyperlinks()

◆ setInsertRows()

◆ setObjects()

◆ setPassword()

◆ setPivotTables()

◆ setSalt()

◆ setScenarios()

◆ setSelectLockedCells()

◆ setSelectUnlockedCells()

◆ setSheet()

◆ setSort()

◆ setSpinCount()

◆ verify()

Field Documentation

◆ $algorithm

◆ $autoFilter

◆ $deleteColumns

◆ $deleteRows

◆ $formatCells

◆ $formatColumns

◆ $formatRows

◆ $insertColumns

◆ $insertHyperlinks

◆ $insertRows

◆ $objects

◆ $password

◆ $pivotTables

◆ $salt

◆ $scenarios

◆ $selectLockedCells

◆ $selectUnlockedCells

◆ $sheet

◆ $sort

◆ $spinCount

◆ ALGORITHM_MD2

◆ ALGORITHM_MD4

◆ ALGORITHM_MD5

◆ ALGORITHM_RIPEMD_128

◆ ALGORITHM_RIPEMD_160

◆ ALGORITHM_SHA_1

◆ ALGORITHM_SHA_256