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/spout/src/Spout/Writer/Common/Manager/ -> SheetManager.php (source)

[Source view]

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

(no description)

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

Defines 1 class

SheetManager:: (7 methods):
  __construct()
  throwIfNameIsInvalid()
  doesContainInvalidCharacters()
  doesStartOrEndWithSingleQuote()
  isNameUnique()
  markWorkbookIdAsUsed()
  markSheetNameAsUsed()


Class: SheetManager  - X-Ref

Class SheetManager
Sheet manager

__construct(StringHelper $stringHelper)   X-Ref
SheetManager constructor.

param: StringHelper $stringHelper

throwIfNameIsInvalid($name, Sheet $sheet)   X-Ref
Throws an exception if the given sheet's name is not valid.

param: string $name
param: Sheet $sheet The sheet whose future name is checked
return: void

doesContainInvalidCharacters($name)   X-Ref
Returns whether the given name contains at least one invalid character.

param: string $name
return: bool TRUE if the name contains invalid characters, FALSE otherwise.

doesStartOrEndWithSingleQuote($name)   X-Ref
Returns whether the given name starts or ends with a single quote

param: string $name
return: bool TRUE if the name starts or ends with a single quote, FALSE otherwise.

isNameUnique($name, Sheet $sheet)   X-Ref
Returns whether the given name is unique.

param: string $name
param: Sheet $sheet The sheet whose future name is checked
return: bool TRUE if the name is unique, FALSE otherwise.

markWorkbookIdAsUsed($workbookId)   X-Ref

param: int $workbookId Workbook ID associated to a Sheet
return: void

markSheetNameAsUsed(Sheet $sheet)   X-Ref

param: Sheet $sheet
return: void