Collaboration diagram for PHPExcel_NamedRange:

Public Member Functions
	__construct ($pName=null, PHPExcel_Worksheet $pWorksheet, $pRange='A1', $pLocalOnly=false, $pScope=null)
	Create a new NamedRange. More...

	getName ()
	Get name. More...

	setName ($value=null)
	Set name. More...

	getWorksheet ()
	Get worksheet. More...

	setWorksheet (PHPExcel_Worksheet $value=null)
	Set worksheet. More...

	getRange ()
	Get range. More...

	setRange ($value=null)
	Set range. More...

	getLocalOnly ()
	Get localOnly. More...

	setLocalOnly ($value=false)
	Set localOnly. More...

	getScope ()
	Get scope. More...

	setScope (PHPExcel_Worksheet $value=null)
	Set scope. More...

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

Static Public Member Functions
static	resolveRange ($pNamedRange='', PHPExcel_Worksheet $pSheet)
	Resolve a named range to a regular cell range. More...

Private Attributes
	$_name

	$_worksheet

	$_range

	$_localOnly

	$_scope

Detailed Description

Definition at line 36 of file NamedRange.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_NamedRange::__construct	(		$pName = `null`,
		PHPExcel_Worksheet	$pWorksheet,
			$pRange = `'A1'`,
			$pLocalOnly = `false`,
			$pScope = `null`
	)

Create a new NamedRange.

Parameters

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

Exceptions

PHPExcel_Exception

Definition at line 83 of file NamedRange.php.

     {
         // Validate data
         if (($pName === NULL) || ($pWorksheet === NULL) || ($pRange === NULL)) {
                 throw new PHPExcel_Exception('Parameters can not be null.');
         }
 
         // Set local members
         $this->_name            = $pName;
         $this->_worksheet       = $pWorksheet;
         $this->_range           = $pRange;
         $this->_localOnly       = $pLocalOnly;
         $this->_scope           = ($pLocalOnly == true) ?
                                                                 (($pScope == null) ? $pWorksheet : $pScope) : null;
     }

Member Function Documentation

◆ __clone()

PHPExcel_NamedRange::__clone ( )

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

Definition at line 236 of file NamedRange.php.

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

◆ getLocalOnly()

PHPExcel_NamedRange::getLocalOnly ( )

Get localOnly.

Returns: bool

Definition at line 185 of file NamedRange.php.

References $_localOnly.

Referenced by PHPExcel_Writer_Excel2007_Workbook\_writeDefinedNameForNamedRange().

                                    {
         return $this->_localOnly;
     }

Here is the caller graph for this function:

◆ getName()

PHPExcel_NamedRange::getName ( )

Get name.

Returns: string

Definition at line 104 of file NamedRange.php.

References $_name.

Referenced by PHPExcel_Writer_Excel2007_Workbook\_writeDefinedNameForNamedRange(), and PHPExcel\addNamedRange().

                               {
         return $this->_name;
     }

Here is the caller graph for this function:

◆ getRange()

PHPExcel_NamedRange::getRange ( )

Get range.

Returns: string

Definition at line 163 of file NamedRange.php.

References $_range.

Referenced by PHPExcel_Writer_Excel2007_Workbook\_writeDefinedNameForNamedRange().

                                {
         return $this->_range;
     }

Here is the caller graph for this function:

◆ getScope()

PHPExcel_NamedRange::getScope ( )

Get scope.

Returns: PHPExcel_Worksheet|null

Definition at line 206 of file NamedRange.php.

References $_scope.

Referenced by PHPExcel_Writer_Excel2007_Workbook\_writeDefinedNameForNamedRange(), and PHPExcel\addNamedRange().

                                {
         return $this->_scope;
     }

Here is the caller graph for this function:

◆ getWorksheet()

PHPExcel_NamedRange::getWorksheet ( )

Get worksheet.

Returns: PHPExcel_Worksheet

Definition at line 141 of file NamedRange.php.

References $_worksheet.

Referenced by PHPExcel_Writer_Excel2007_Workbook\_writeDefinedNameForNamedRange().

                                    {
         return $this->_worksheet;
     }

Here is the caller graph for this function:

◆ resolveRange()

static PHPExcel_NamedRange::resolveRange	(		$pNamedRange = `''`,
		PHPExcel_Worksheet	$pSheet
	)

static

Resolve a named range to a regular cell range.

Parameters

string	$pNamedRange	Named range
PHPExcel_Worksheet \| null	$pSheet	Scope. Use null for global scope

Returns: PHPExcel_NamedRange

Definition at line 229 of file NamedRange.php.

References PHPExcel_Worksheet\getParent().

Referenced by PHPExcel_Worksheet\cellExists(), PHPExcel_Calculation\extractNamedRange(), PHPExcel_Worksheet\getCell(), and PHPExcel_Worksheet\namedRangeToArray().

                                                                                        {
                 return $pSheet->getParent()->getNamedRange($pNamedRange, $pSheet);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLocalOnly()

PHPExcel_NamedRange::setLocalOnly ( $value = false )

Set localOnly.

Parameters

bool $value

Returns: PHPExcel_NamedRange

Definition at line 195 of file NamedRange.php.

                                                  {
         $this->_localOnly = $value;
         $this->_scope = $value ? $this->_worksheet : null;
         return $this;
     }

◆ setName()

PHPExcel_NamedRange::setName ( $value = null )

Set name.

Parameters

string $value

Returns: PHPExcel_NamedRange

Definition at line 114 of file NamedRange.php.

References $_name, and PHPExcel_ReferenceHelper\getInstance().

                                            {
         if ($value !== NULL) {
                 // Old title
                 $oldTitle = $this->_name;
 
                 // Re-attach
                 if ($this->_worksheet !== NULL) {
                         $this->_worksheet->getParent()->removeNamedRange($this->_name,$this->_worksheet);
                 }
                 $this->_name = $value;
 
                 if ($this->_worksheet !== NULL) {
                         $this->_worksheet->getParent()->addNamedRange($this);
                 }
 
                 // New title
                 $newTitle = $this->_name;
                 PHPExcel_ReferenceHelper::getInstance()->updateNamedFormulas($this->_worksheet->getParent(), $oldTitle, $newTitle);
         }
         return $this;
     }

Here is the call graph for this function:

◆ setRange()

PHPExcel_NamedRange::setRange ( $value = null )

Set range.

Parameters

string $value

Returns: PHPExcel_NamedRange

Definition at line 173 of file NamedRange.php.

                                             {
         if ($value !== NULL) {
                 $this->_range = $value;
         }
         return $this;
     }

◆ setScope()

PHPExcel_NamedRange::setScope ( PHPExcel_Worksheet $value = null )

Set scope.

Parameters

PHPExcel_Worksheet | null $value

Returns: PHPExcel_NamedRange

Definition at line 216 of file NamedRange.php.

                                                                {
         $this->_scope = $value;
         $this->_localOnly = ($value == null) ? false : true;
         return $this;
     }

◆ setWorksheet()

PHPExcel_NamedRange::setWorksheet ( PHPExcel_Worksheet $value = null )

Set worksheet.

Parameters

PHPExcel_Worksheet $value

Returns: PHPExcel_NamedRange

Definition at line 151 of file NamedRange.php.

                                                                    {
         if ($value !== NULL) {
                 $this->_worksheet = $value;
         }
         return $this;
     }

Field Documentation

◆ $_localOnly

PHPExcel_NamedRange::$_localOnly

private

Definition at line 64 of file NamedRange.php.

Referenced by getLocalOnly().

◆ $_name

PHPExcel_NamedRange::$_name

private

Definition at line 43 of file NamedRange.php.

Referenced by getName(), and setName().

◆ $_range

PHPExcel_NamedRange::$_range

private

Definition at line 57 of file NamedRange.php.

Referenced by getRange().

◆ $_scope

PHPExcel_NamedRange::$_scope

private

Definition at line 71 of file NamedRange.php.

Referenced by getScope().

◆ $_worksheet

PHPExcel_NamedRange::$_worksheet

private

Definition at line 50 of file NamedRange.php.

Referenced by getWorksheet().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/NamedRange.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getLocalOnly()

◆ getName()

◆ getRange()

◆ getScope()

◆ getWorksheet()

◆ resolveRange()

◆ setLocalOnly()

◆ setName()

◆ setRange()

◆ setScope()

◆ setWorksheet()

Field Documentation

◆ $_localOnly

◆ $_name

◆ $_range

◆ $_scope

◆ $_worksheet