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.

(no description)

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

Defines 1 class

Sheet:: (7 methods):
  __construct()
  getIndex()
  getAssociatedWorkbookId()
  getName()
  setName()
  isVisible()
  setIsVisible()


Class: Sheet  - X-Ref

Class Sheet
External representation of a worksheet

__construct($sheetIndex, $associatedWorkbookId, SheetManager $sheetManager)   X-Ref

param: int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
param: string $associatedWorkbookId ID of the sheet's associated workbook
param: SheetManager $sheetManager To manage sheets

getIndex()   X-Ref

return: int Index of the sheet, based on order in the workbook (zero-based)

getAssociatedWorkbookId()   X-Ref

return: string

getName()   X-Ref

return: string Name of the sheet

setName($name)   X-Ref
Sets the name of the sheet. Note that Excel has some restrictions on the name:
- it should not be blank
- it should not exceed 31 characters
- it should not contain these characters: \ / ? * : [ or ]
- it should be unique

param: string $name Name of the sheet
return: Sheet

isVisible()   X-Ref

return: bool isVisible Visibility of the sheet

setIsVisible($isVisible)   X-Ref

param: bool $isVisible Visibility of the sheet
return: Sheet