Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

(no description)

File Size: 198 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Protection:: (10 methods):
  __construct()
  getSharedComponent()
  getStyleArray()
  applyFromArray()
  getLocked()
  setLocked()
  getHidden()
  setHidden()
  getHashCode()
  exportArray1()


Class: Protection  - X-Ref

__construct($isSupervisor = false, $isConditional = false)   X-Ref
Create a new Protection.

param: bool $isSupervisor Flag indicating if this is a supervisor or not
param: bool $isConditional Flag indicating if this is a conditional style or not

getSharedComponent()   X-Ref
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor.

return: Protection

getStyleArray($array)   X-Ref
Build style array from subcomponents.

param: array $array
return: array

applyFromArray(array $styleArray)   X-Ref
Apply styles from array.

<code>
$spreadsheet->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray(
[
'locked' => TRUE,
'hidden' => FALSE
]
);
</code>

param: array $styleArray Array containing style information
return: $this

getLocked()   X-Ref
Get locked.

return: string

setLocked($lockType)   X-Ref
Set locked.

param: string $lockType see self::PROTECTION_*
return: $this

getHidden()   X-Ref
Get hidden.

return: string

setHidden($hiddenType)   X-Ref
Set hidden.

param: string $hiddenType see self::PROTECTION_*
return: $this

getHashCode()   X-Ref
Get hash code.

return: string Hash code

exportArray1()   X-Ref
No description