Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

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

(no description)

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

Defines 1 class

NamedRange:: (13 methods):
  __construct()
  getName()
  setName()
  getWorksheet()
  setWorksheet()
  getRange()
  setRange()
  getLocalOnly()
  setLocalOnly()
  getScope()
  setScope()
  resolveRange()
  __clone()


Class: NamedRange  - X-Ref

__construct($pName, Worksheet $pWorksheet, $pRange = 'A1', $pLocalOnly = false, $pScope = null)   X-Ref
Create a new NamedRange.

param: string $pName
param: Worksheet $pWorksheet
param: string $pRange
param: bool $pLocalOnly
param: null|Worksheet $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope.

getName()   X-Ref
Get name.

return: string

setName($value)   X-Ref
Set name.

param: string $value
return: NamedRange

getWorksheet()   X-Ref
Get worksheet.

return: Worksheet

setWorksheet(Worksheet $value = null)   X-Ref
Set worksheet.

param: Worksheet $value
return: NamedRange

getRange()   X-Ref
Get range.

return: string

setRange($value)   X-Ref
Set range.

param: string $value
return: NamedRange

getLocalOnly()   X-Ref
Get localOnly.

return: bool

setLocalOnly($value)   X-Ref
Set localOnly.

param: bool $value
return: NamedRange

getScope()   X-Ref
Get scope.

return: null|Worksheet

setScope(Worksheet $value = null)   X-Ref
Set scope.

param: null|Worksheet $value
return: NamedRange

resolveRange($pNamedRange, Worksheet $pSheet)   X-Ref
Resolve a named range to a regular cell range.

param: string $pNamedRange Named range
param: null|Worksheet $pSheet Scope. Use null for global scope
return: NamedRange

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