Inheritance diagram for PhpOffice\PhpSpreadsheet\DefinedName:

Collaboration diagram for PhpOffice\PhpSpreadsheet\DefinedName:

Public Member Functions
	__construct (string $name, ?Worksheet $worksheet=null, ?string $value=null, bool $localOnly=false, ?Worksheet $scope=null)
	Create a new Defined Name. More...

	getName ()
	Get name. More...

	setName (string $name)
	Set name. More...

	getWorksheet ()
	Get worksheet. More...

	setWorksheet (?Worksheet $value)
	Set worksheet. More...

	getValue ()
	Get range or formula value. More...

	setValue (string $value)
	Set range or formula value. More...

	getLocalOnly ()
	Get localOnly. More...

	setLocalOnly (bool $value)
	Set localOnly. More...

	getScope ()
	Get scope. More...

	setScope (?Worksheet $value)
	Set scope. More...

	isFormula ()
	Identify whether this is a named range or a named formula. More...

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

Static Public Member Functions
static	createInstance (string $name, ?Worksheet $worksheet=null, ?string $value=null, bool $localOnly=false, ?Worksheet $scope=null)
	Create a new defined name, either a range or a formula. More...

static	testIfFormula (string $value)

static	resolveName (string $pDefinedName, Worksheet $pSheet, string $sheetName='')
	Resolve a named range to a regular cell range or formula. More...

Protected Attributes
const	REGEXP_IDENTIFY_FORMULA = '[^_\p{N}\p{L}:, \$\'!]'

	$name

	$worksheet

	$value

	$localOnly

	$scope

	$isFormula

Detailed Description

Definition at line 7 of file DefinedName.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\DefinedName::__construct	(	string	$name,
		?Worksheet	$worksheet = `null`,
		?string	$value = `null`,
		bool	$localOnly = `false`,
		?Worksheet	$scope = `null`
	)

Create a new Defined Name.

Definition at line 56 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$localOnly, PhpOffice\PhpSpreadsheet\DefinedName\$name, PhpOffice\PhpSpreadsheet\DefinedName\$scope, PhpOffice\PhpSpreadsheet\DefinedName\$value, PhpOffice\PhpSpreadsheet\DefinedName\$worksheet, and PhpOffice\PhpSpreadsheet\DefinedName\isFormula().

       {
         if ($worksheet === null) {
             $worksheet = $scope;
         }
 
         // Set local members
         $this->name = $name;
         $this->worksheet = $worksheet;
         $this->value = (string) $value;
         $this->localOnly = $localOnly;
         // If local only, then the scope will be set to worksheet unless a scope is explicitly set
         $this->scope = ($localOnly === true) ? (($scope === null) ? $worksheet : $scope) : null;
         // If the range string contains characters that aren't associated with the range definition (A-Z,1-9
         //      for cell references, and $, or the range operators (colon comma or space), quotes and ! for
         //      worksheet names
         //  then this is treated as a named formula, and not a named range
         $this->isFormula = self::testIfFormula($this->value);
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\DefinedName::__clone ( )

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

Definition at line 261 of file DefinedName.php.

References $key, and PhpOffice\PhpSpreadsheet\DefinedName\$value.

     {
         $vars = get_object_vars($this);
         foreach ($vars as $key => $value) {
             if (is_object($value)) {
                 $this->$key = clone $value;
             } else {
                 $this->$key = $value;
             }
         }
     }

◆ createInstance()

static PhpOffice\PhpSpreadsheet\DefinedName::createInstance	(	string	$name,
		?Worksheet	$worksheet = `null`,
		?string	$value = `null`,
		bool	$localOnly = `false`,
		?Worksheet	$scope = `null`
	)

static

Create a new defined name, either a range or a formula.

Definition at line 84 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$isFormula, PhpOffice\PhpSpreadsheet\DefinedName\$localOnly, PhpOffice\PhpSpreadsheet\DefinedName\$scope, PhpOffice\PhpSpreadsheet\DefinedName\$value, and PhpOffice\PhpSpreadsheet\DefinedName\$worksheet.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Ods\DefinedNames\addDefinedName(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), PhpOffice\PhpSpreadsheet\Reader\Xml\load(), and PhpOffice\PhpSpreadsheet\Reader\Gnumeric\processDefinedNames().

      : self {
         $value = (string) $value;
         $isFormula = self::testIfFormula($value);
         if ($isFormula) {
             return new NamedFormula($name, $worksheet, $value, $localOnly, $scope);
         }
 
         return new NamedRange($name, $worksheet, $value, $localOnly, $scope);
     }

Here is the caller graph for this function:

◆ getLocalOnly()

PhpOffice\PhpSpreadsheet\DefinedName::getLocalOnly ( )

Get localOnly.

Definition at line 198 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$localOnly.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames\writeDefinedName().

                                   : bool
     {
         return $this->localOnly;
     }

Here is the caller graph for this function:

◆ getName()

PhpOffice\PhpSpreadsheet\DefinedName::getName ( )

Get name.

Definition at line 127 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$name.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addDefinedName(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames\writeDefinedName(), PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\writeNamedFormula(), and PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\writeNamedRange().

                              : string
     {
         return $this->name;
     }

Here is the caller graph for this function:

◆ getScope()

PhpOffice\PhpSpreadsheet\DefinedName::getScope ( )

Get scope.

Definition at line 217 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$scope.

Referenced by PhpOffice\PhpSpreadsheet\Spreadsheet\addDefinedName(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames\writeDefinedName().

                               : ?Worksheet
     {
         return $this->scope;
     }

Here is the caller graph for this function:

◆ getValue()

PhpOffice\PhpSpreadsheet\DefinedName::getValue ( )

Get range or formula value.

Definition at line 180 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$value.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\parseDefinedNameValue(), PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\writeNamedFormula(), and PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\writeNamedRange().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ getWorksheet()

PhpOffice\PhpSpreadsheet\DefinedName::getWorksheet ( )

Get worksheet.

Definition at line 162 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$worksheet.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\convertAddress(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\parseDefinedNameValue(), PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\writeNamedFormula(), and PhpOffice\PhpSpreadsheet\Writer\Ods\NamedExpressions\writeNamedRange().

                                   : ?Worksheet
     {
         return $this->worksheet;
     }

Here is the caller graph for this function:

◆ isFormula()

PhpOffice\PhpSpreadsheet\DefinedName::isFormula ( )

Identify whether this is a named range or a named formula.

Definition at line 236 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$isFormula.

Referenced by PhpOffice\PhpSpreadsheet\DefinedName\__construct(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedFormulae(), and PhpOffice\PhpSpreadsheet\Spreadsheet\getNamedRanges().

                                : bool
     {
         return $this->isFormula;
     }

Here is the caller graph for this function:

◆ resolveName()

static PhpOffice\PhpSpreadsheet\DefinedName::resolveName	(	string	$pDefinedName,
		Worksheet	$pSheet,
		string	$sheetName = `''`
	)

static

Resolve a named range to a regular cell range or formula.

Definition at line 244 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getParent().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Helpers\extractCellAddresses(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\extractNamedRange(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\processTokenStack(), and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\validateNamedRange().

                                                                                                        : ?self
     {
         if ($sheetName === '') {
             $pSheet2 = $pSheet;
         } else {
             $pSheet2 = $pSheet->getParent()->getSheetByName($sheetName);
             if ($pSheet2 === null) {
                 return null;
             }
         }
 
         return $pSheet->getParent()->getDefinedName($pDefinedName, $pSheet2);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLocalOnly()

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

Set localOnly.

Definition at line 206 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$value.

                                              : self
     {
         $this->localOnly = $value;
         $this->scope = $value ? $this->worksheet : null;
 
         return $this;
     }

◆ setName()

PhpOffice\PhpSpreadsheet\DefinedName::setName ( string $name )

Set name.

Definition at line 135 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$name, and PhpOffice\PhpSpreadsheet\ReferenceHelper\getInstance().

                                          : self
     {
         if (!empty($name)) {
             // Old title
             $oldTitle = $this->name;
 
             // Re-attach
             if ($this->worksheet !== null) {
                 $this->worksheet->getParent()->removeNamedRange($this->name, $this->worksheet);
             }
             $this->name = $name;
 
             if ($this->worksheet !== null) {
                 $this->worksheet->getParent()->addNamedRange($this);
             }
 
             // New title
             $newTitle = $this->name;
             ReferenceHelper::getInstance()->updateNamedFormulas($this->worksheet->getParent(), $oldTitle, $newTitle);
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ setScope()

PhpOffice\PhpSpreadsheet\DefinedName::setScope ( ?Worksheet $value )

Set scope.

Definition at line 225 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$value.

                                                : self
     {
         $this->scope = $value;
         $this->localOnly = $value !== null;
 
         return $this;
     }

◆ setValue()

PhpOffice\PhpSpreadsheet\DefinedName::setValue ( string $value )

Set range or formula value.

Definition at line 188 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$value.

                                            : self
     {
         $this->value = $value;
 
         return $this;
     }

◆ setWorksheet()

PhpOffice\PhpSpreadsheet\DefinedName::setWorksheet ( ?Worksheet $value )

Set worksheet.

Definition at line 170 of file DefinedName.php.

References PhpOffice\PhpSpreadsheet\DefinedName\$value.

                                                    : self
     {
         $this->worksheet = $value;
 
         return $this;
     }

◆ testIfFormula()

static PhpOffice\PhpSpreadsheet\DefinedName::testIfFormula ( string $value )

static

Definition at line 100 of file DefinedName.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                        : bool
     {
         if (substr($value, 0, 1) === '=') {
             $value = substr($value, 1);
         }
 
         if (is_numeric($value)) {
             return true;
         }
 
         $segMatcher = false;
         foreach (explode("'", $value) as $subVal) {
             //    Only test in alternate array entries (the non-quoted blocks)
             if (
                 ($segMatcher = !$segMatcher) &&
                 (preg_match('/' . self::REGEXP_IDENTIFY_FORMULA . '/miu', $subVal))
             ) {
                 return true;
             }
         }
 
         return false;
     }

Here is the caller graph for this function:

Field Documentation

◆ $isFormula

PhpOffice\PhpSpreadsheet\DefinedName::$isFormula

protected

Definition at line 51 of file DefinedName.php.

Referenced by PhpOffice\PhpSpreadsheet\DefinedName\createInstance(), and PhpOffice\PhpSpreadsheet\DefinedName\isFormula().

◆ $localOnly

PhpOffice\PhpSpreadsheet\DefinedName::$localOnly

protected

Definition at line 37 of file DefinedName.php.

Referenced by PhpOffice\PhpSpreadsheet\NamedFormula\__construct(), PhpOffice\PhpSpreadsheet\NamedRange\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\createInstance(), and PhpOffice\PhpSpreadsheet\DefinedName\getLocalOnly().

◆ $name

PhpOffice\PhpSpreadsheet\DefinedName::$name

protected

Definition at line 16 of file DefinedName.php.

Referenced by PhpOffice\PhpSpreadsheet\DefinedName\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\getName(), and PhpOffice\PhpSpreadsheet\DefinedName\setName().

◆ $scope

PhpOffice\PhpSpreadsheet\DefinedName::$scope

protected

Definition at line 44 of file DefinedName.php.

Referenced by PhpOffice\PhpSpreadsheet\NamedFormula\__construct(), PhpOffice\PhpSpreadsheet\NamedRange\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\createInstance(), and PhpOffice\PhpSpreadsheet\DefinedName\getScope().

◆ $value

PhpOffice\PhpSpreadsheet\DefinedName::$value

protected

Definition at line 30 of file DefinedName.php.

◆ $worksheet

PhpOffice\PhpSpreadsheet\DefinedName::$worksheet

protected

Definition at line 23 of file DefinedName.php.

Referenced by PhpOffice\PhpSpreadsheet\NamedFormula\__construct(), PhpOffice\PhpSpreadsheet\NamedRange\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\__construct(), PhpOffice\PhpSpreadsheet\DefinedName\createInstance(), and PhpOffice\PhpSpreadsheet\DefinedName\getWorksheet().

◆ REGEXP_IDENTIFY_FORMULA

const PhpOffice\PhpSpreadsheet\DefinedName::REGEXP_IDENTIFY_FORMULA = '[^_\p{N}\p{L}:, \$\'!]'

protected

Definition at line 9 of file DefinedName.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/DefinedName.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ createInstance()

◆ getLocalOnly()

◆ getName()

◆ getScope()

◆ getValue()

◆ getWorksheet()

◆ isFormula()

◆ resolveName()

◆ setLocalOnly()

◆ setName()

◆ setScope()

◆ setValue()

◆ setWorksheet()

◆ testIfFormula()

Field Documentation

◆ $isFormula

◆ $localOnly

◆ $name

◆ $scope

◆ $value

◆ $worksheet

◆ REGEXP_IDENTIFY_FORMULA