Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

(no description)

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

Defines 1 class

Borders:: (18 methods):
  __construct()
  getSharedComponent()
  getStyleArray()
  applyFromArray()
  getLeft()
  getRight()
  getTop()
  getBottom()
  getDiagonal()
  getAllBorders()
  getOutline()
  getInside()
  getVertical()
  getHorizontal()
  getDiagonalDirection()
  setDiagonalDirection()
  getHashCode()
  exportArray1()


Class: Borders  - X-Ref

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

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: Borders

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

param: array $array
return: array

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

<code>
$spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray(
[
'bottom' => [
'borderStyle' => Border::BORDER_DASHDOT,
'color' => [
'rgb' => '808080'
]
],
'top' => [
'borderStyle' => Border::BORDER_DASHDOT,
'color' => [
'rgb' => '808080'
]
]
]
);
</code>

<code>
$spreadsheet->getActiveSheet()->getStyle('B2')->getBorders()->applyFromArray(
[
'allBorders' => [
'borderStyle' => Border::BORDER_DASHDOT,
'color' => [
'rgb' => '808080'
]
]
]
);
</code>

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

getLeft()   X-Ref
Get Left.

return: Border

getRight()   X-Ref
Get Right.

return: Border

getTop()   X-Ref
Get Top.

return: Border

getBottom()   X-Ref
Get Bottom.

return: Border

getDiagonal()   X-Ref
Get Diagonal.

return: Border

getAllBorders()   X-Ref
Get AllBorders (pseudo-border). Only applies to supervisor.

return: Border

getOutline()   X-Ref
Get Outline (pseudo-border). Only applies to supervisor.

return: Border

getInside()   X-Ref
Get Inside (pseudo-border). Only applies to supervisor.

return: Border

getVertical()   X-Ref
Get Vertical (pseudo-border). Only applies to supervisor.

return: Border

getHorizontal()   X-Ref
Get Horizontal (pseudo-border). Only applies to supervisor.

return: Border

getDiagonalDirection()   X-Ref
Get DiagonalDirection.

return: int

setDiagonalDirection($pValue)   X-Ref
Set DiagonalDirection.

param: int $pValue see self::DIAGONAL_*
return: $this

getHashCode()   X-Ref
Get hash code.

return: string Hash code

exportArray1()   X-Ref
No description