\PhpOffice\PhpSpreadsheetNamedRange

Summary

Methods
Properties
Constants
__construct()
getName()
setName()
getWorksheet()
setWorksheet()
getRange()
setRange()
getLocalOnly()
setLocalOnly()
getScope()
setScope()
resolveRange()
__clone()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$name
$worksheet
$range
$localOnly
$scope
N/A

Properties

$name

$name : string

Range name.

Type

string

$worksheet

$worksheet : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Worksheet on which the named range can be resolved.

Type

Worksheet

$range

$range : string

Range of the referenced cells.

Type

string

$localOnly

$localOnly : bool

Is the named range local? (i.e. can only be used on $this->worksheet).

Type

bool

$scope

$scope : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Scope.

Type

Worksheet

Methods

__construct()

__construct(string  $pName, \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pWorksheet, string  $pRange = 'A1', bool  $pLocalOnly = false, null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pScope = null) : mixed

Create a new NamedRange.

Parameters

string $pName
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet
string $pRange
bool $pLocalOnly
null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pScope

Scope. Only applies when $pLocalOnly = true. Null for global scope.

Throws

\PhpOffice\PhpSpreadsheet\Exception

Returns

mixed —

getName()

getName() : string

Get name.

Returns

string —

setName()

setName(string  $value) : \PhpOffice\PhpSpreadsheet\NamedRange

Set name.

Parameters

string $value

Returns

\PhpOffice\PhpSpreadsheet\NamedRange —

getWorksheet()

getWorksheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get worksheet.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

setWorksheet()

setWorksheet(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $value = null) : \PhpOffice\PhpSpreadsheet\NamedRange

Set worksheet.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $value

Returns

\PhpOffice\PhpSpreadsheet\NamedRange —

getRange()

getRange() : string

Get range.

Returns

string —

setRange()

setRange(string  $value) : \PhpOffice\PhpSpreadsheet\NamedRange

Set range.

Parameters

string $value

Returns

\PhpOffice\PhpSpreadsheet\NamedRange —

getLocalOnly()

getLocalOnly() : bool

Get localOnly.

Returns

bool —

setLocalOnly()

setLocalOnly(bool  $value) : \PhpOffice\PhpSpreadsheet\NamedRange

Set localOnly.

Parameters

bool $value

Returns

\PhpOffice\PhpSpreadsheet\NamedRange —

getScope()

getScope() : null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get scope.

Returns

null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet —

setScope()

setScope(null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $value = null) : \PhpOffice\PhpSpreadsheet\NamedRange

Set scope.

Parameters

null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $value

Returns

\PhpOffice\PhpSpreadsheet\NamedRange —

resolveRange()

resolveRange(string  $pNamedRange, null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet) : \PhpOffice\PhpSpreadsheet\NamedRange

Resolve a named range to a regular cell range.

Parameters

string $pNamedRange

Named range

null|\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet

Scope. Use null for global scope

Returns

\PhpOffice\PhpSpreadsheet\NamedRange —

__clone()

__clone() : mixed

Implement PHP __clone to create a deep clone, not just a shallow copy.

Returns

mixed —