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: 175 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Supervisor:: (9 methods):
  __construct()
  bindParent()
  getIsSupervisor()
  getActiveSheet()
  getSelectedCells()
  getActiveCell()
  __clone()
  exportArray()
  exportArray2()


Class: Supervisor  - X-Ref

__construct($isSupervisor = false)   X-Ref
Create a new Supervisor.

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

bindParent($parent, $parentPropertyName = null)   X-Ref
Bind parent. Only used for supervisor.

param: Spreadsheet|Supervisor $parent
param: null|string $parentPropertyName
return: $this

getIsSupervisor()   X-Ref
Is this a supervisor or a cell style component?

return: bool

getActiveSheet()   X-Ref
Get the currently active sheet. Only used for supervisor.

return: Worksheet

getSelectedCells()   X-Ref
Get the currently active cell coordinate in currently active sheet.
Only used for supervisor.

return: string E.g. 'A1'

getActiveCell()   X-Ref
Get the currently active cell coordinate in currently active sheet.
Only used for supervisor.

return: string E.g. 'A1'

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


exportArray()   X-Ref
Export style as array.

Available to anything which extends this class:
Alignment, Border, Borders, Color, Fill, Font,
NumberFormat, Protection, and Style.

exportArray2(array &$exportedArray, string $index, $objOrValue)   X-Ref
Populate array from exportArray1.
This method is available to anything which extends this class.
The parameter index is the key to be added to the array.
The parameter objOrValue is either a primitive type,
which is the value added to the array,
or a Style object to be recursively added via exportArray.

param: mixed $objOrValue