<?php

namespace PhpOffice\PhpSpreadsheet;

use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;

class NamedRange extends DefinedName
{
    /**
     * Create a new Named Range.
     */
    public function __construct(
        string $name,
        ?Worksheet $worksheet = null,
        string $range = 'A1',
        bool $localOnly = false,
        ?Worksheet $scope = null
    ) {
        if ($worksheet === null && $scope === null) {
            throw new Exception('You must specify a worksheet or a scope for a Named Range');
        }
        parent::__construct($name, $worksheet, $range, $localOnly, $scope);
    }

    /**
     * Get the range value.
     */
    public function getRange(): string
    {
        return $this->value;
    }

    /**
     * Set the range value.
     */
    public function setRange(string $range): self
    {
        if (!empty($range)) {
            $this->value = $range;
        }

        return $this;
    }

    public function getCellsInRange(): array
    {
        $range = $this->value;
        if (substr($range, 0, 1) === '=') {
            $range = substr($range, 1);
        }

        return Coordinate::extractAllCellReferencesInRange($range);
    }
}

• [D] Calculation
• [D] Cell
• [D] Chart
• [D] Collection
• [D] Document
• [D] Helper
• [D] Reader
• [D] RichText
• [D] Shared
• [D] Style
• [D] Worksheet
• [D] Writer
• [F] CellReferenceHelper.php
  Delete
• [F] Comment.php
  Delete
• [F] DefinedName.php
  Delete
• [F] Exception.php
  Delete
• [F] HashTable.php
  Delete
• [F] IComparable.php
  Delete
• [F] IOFactory.php
  Delete
• [F] NamedFormula.php
  Delete
• [F] NamedRange.php
  Delete
• [F] ReferenceHelper.php
  Delete
• [F] Settings.php
  Delete
• [F] Spreadsheet.php
  Delete
• [F] Theme.php
  Delete

Developer

• Support

Back to Home page