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.
/lib/phpspreadsheet/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Worksheet/ -> Table.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

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

Defines 1 class

Table:: (24 methods):
  __construct()
  getName()
  setName()
  getShowHeaderRow()
  setShowHeaderRow()
  getShowTotalsRow()
  setShowTotalsRow()
  getRange()
  setRange()
  setRangeToMaxRow()
  getWorksheet()
  setWorksheet()
  getColumns()
  isColumnInRange()
  getColumnOffset()
  getColumn()
  getColumnByOffset()
  setColumn()
  clearColumn()
  shiftColumn()
  getStyle()
  setStyle()
  __clone()
  __toString()


Class: Table  - X-Ref

__construct($range = '', string $name = '')   X-Ref
Create a new Table.

param: AddressRange|array<int>|string $range
param: string $name (e.g. Table1)

getName()   X-Ref
Get Table name.


setName(string $name)   X-Ref
Set Table name.


getShowHeaderRow()   X-Ref
Get show Header Row.


setShowHeaderRow(bool $showHeaderRow)   X-Ref
Set show Header Row.


getShowTotalsRow()   X-Ref
Get show Totals Row.


setShowTotalsRow(bool $showTotalsRow)   X-Ref
Set show Totals Row.


getRange()   X-Ref
Get Table Range.


setRange($range = '')   X-Ref
Set Table Cell Range.

param: AddressRange|array<int>|string $range

setRangeToMaxRow()   X-Ref
Set Table Cell Range to max row.


getWorksheet()   X-Ref
Get Table's Worksheet.


setWorksheet(?Worksheet $worksheet = null)   X-Ref
Set Table's Worksheet.


getColumns()   X-Ref
Get all Table Columns.

return: Table\Column[]

isColumnInRange(string $column)   X-Ref
Validate that the specified column is in the Table range.

param: string $column Column name (e.g. A)
return: int The column offset within the table range

getColumnOffset($column)   X-Ref
Get a specified Table Column Offset within the defined Table range.

param: string $column Column name (e.g. A)
return: int The offset of the specified column within the table range

getColumn($column)   X-Ref
Get a specified Table Column.

param: string $column Column name (e.g. A)

getColumnByOffset($columnOffset)   X-Ref
Get a specified Table Column by it's offset.

param: int $columnOffset Column offset within range (starting from 0)

setColumn($columnObjectOrString)   X-Ref
Set Table.

param: string|Table\Column $columnObjectOrString

clearColumn($column)   X-Ref
Clear a specified Table Column.

param: string $column Column name (e.g. A)

shiftColumn($fromColumn, $toColumn)   X-Ref
Shift an Table Column Rule to a different column.

Note: This method bypasses validation of the destination column to ensure it is within this Table range.
Nor does it verify whether any column rule already exists at $toColumn, but will simply override any existing value.
Use with caution.

param: string $fromColumn Column name (e.g. A)
param: string $toColumn Column name (e.g. B)

getStyle()   X-Ref
Get table Style.


setStyle(TableStyle $style)   X-Ref
Set table Style.


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


__toString()   X-Ref
toString method replicates previous behavior by returning the range if object is
referenced as a property of its worksheet.