PhpOffice\PhpSpreadsheet\Cell\Coordinate Class Reference

Helper class to manipulate cell coordinates. More...

Collaboration diagram for PhpOffice\PhpSpreadsheet\Cell\Coordinate:

Static Public Member Functions
static	coordinateFromString ($pCoordinateString)
	Coordinate from string. More...
static	indexesFromString (string $coordinates)
	Get indexes from a string coordinates. More...
static	coordinateIsRange ($coord)
	Checks if a coordinate represents a range of cells. More...
static	absoluteReference ($pCoordinateString)
	Make string row, column or cell coordinate absolute. More...
static	absoluteCoordinate ($pCoordinateString)
	Make string coordinate absolute. More...
static	splitRange ($pRange)
	Split range into coordinate strings. More...
static	buildRange (array $pRange)
	Build range from coordinate strings. More...
static	rangeBoundaries ($pRange)
	Calculate range boundaries. More...
static	rangeDimension ($pRange)
	Calculate range dimension. More...
static	getRangeBoundaries ($pRange)
	Calculate range boundaries. More...
static	columnIndexFromString ($pString)
	Column index from string. More...
static	stringFromColumnIndex ($columnIndex)
	String from column index. More...
static	extractAllCellReferencesInRange ($cellRange)
	Extract all cell references in range, which may be comprised of multiple cell ranges. More...
static	mergeRangesInCollection (array $pCoordCollection)
	Convert an associative array of single cell coordinates to values to an associative array of cell ranges to values. More...

Data Fields
const	A1_COORDINATE_REGEX = '/^(?<absolute_col>\$?)(?<col_ref>[A-Z]{1,3})(?<absolute_row>\$?)(?<row_ref>\d{1,7})$/i'
const	DEFAULT_RANGE = 'A1:A1'

Static Private Member Functions
static	processRangeSetOperators (array $operators, array $cells)
static	sortCellReferenceArray (array $cellList)
static	getReferencesForCellBlock ($cellBlock)
	Get all cell references for an individual cell block. More...
static	getCellBlocksFromRangeString ($rangeString)
	Get the individual cell blocks from a range string, removing any $ characters. More...
static	validateRange ($cellBlock, $startColumnIndex, $endColumnIndex, $currentRow, $endRow)
	Check that the given range is valid, i.e. More...

Detailed Description

Helper class to manipulate cell coordinates.

Columns indexes and rows are always based on 1, not on 0. This match the behavior that Excel users are used to, and also match the Excel functions COLUMN() and ROW().

Definition at line 14 of file Coordinate.php.

Member Function Documentation

absoluteCoordinate()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::absoluteCoordinate (   $pCoordinateString )

static

Make string coordinate absolute.

Parameters

string

$pCoordinateString

e.g. 'A1'

Returns

string Absolute coordinate e.g. '$A$1'

Definition at line 111 of file Coordinate.php.

    {
        if (self::coordinateIsRange($pCoordinateString)) {
            throw new Exception('Cell coordinate string can not be a range of cells');
        }
 
        // Split out any worksheet name from the coordinate
        [$worksheet, $pCoordinateString] = Worksheet::extractSheetTitle($pCoordinateString, true);
        if ($worksheet > '') {
            $worksheet .= '!';
        }
 
        // Create absolute coordinate
        [$column, $row] = self::coordinateFromString($pCoordinateString);
        $column = ltrim($column, '$');
        $row = ltrim($row, '$');
 
        return $worksheet . '$' . $column . '$' . $row;
    }

References $row, and PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString().

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\absoluteReference(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames\writeNamedRangeForAutofilter().

Here is the call graph for this function:

Here is the caller graph for this function:

absoluteReference()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::absoluteReference (   $pCoordinateString )

static

Make string row, column or cell coordinate absolute.

Parameters

string

$pCoordinateString

e.g. 'A' or '1' or 'A1' Note that this value can be a row or column reference as well as a cell reference

Returns

string Absolute coordinate e.g. '$A' or '$1' or '$A$1'

Definition at line 82 of file Coordinate.php.

    {
        if (self::coordinateIsRange($pCoordinateString)) {
            throw new Exception('Cell coordinate string can not be a range of cells');
        }
 
        // Split out any worksheet name from the reference
        [$worksheet, $pCoordinateString] = Worksheet::extractSheetTitle($pCoordinateString, true);
        if ($worksheet > '') {
            $worksheet .= '!';
        }
 
        // Create absolute coordinate
        if (ctype_digit($pCoordinateString)) {
            return $worksheet . '$' . $pCoordinateString;
        } elseif (ctype_alpha($pCoordinateString)) {
            return $worksheet . '$' . strtoupper($pCoordinateString);
        }
 
        return $worksheet . self::absoluteCoordinate($pCoordinateString);
    }

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\absoluteCoordinate().

Here is the call graph for this function:

buildRange()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::buildRange ( array  $pRange )

static

Build range from coordinate strings.

Parameters

array

$pRange

Array containg one or more arrays containing one or two coordinate strings

Returns

string String representation of $pRange

Definition at line 163 of file Coordinate.php.

    {
        // Verify range
        if (empty($pRange) || !is_array($pRange[0])) {
            throw new Exception('Range does not contain any information');
        }
 
        // Build range
        $counter = count($pRange);
        for ($i = 0; $i < $counter; ++$i) {
            $pRange[$i] = implode(':', $pRange[$i]);
        }
 
        return implode(',', $pRange);
    }

References $i.

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellRange().

Here is the caller graph for this function:

columnIndexFromString()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::columnIndexFromString (   $pString )

static

Column index from string.

Parameters

string

$pString

eg 'A'

Returns

int Column index (A = 1)

Definition at line 265 of file Coordinate.php.

    {
        //    Using a lookup cache adds a slight memory overhead, but boosts speed
        //    caching using a static within the method is faster than a class static,
        //        though it's additional memory overhead
        static $indexCache = [];
 
        if (isset($indexCache[$pString])) {
            return $indexCache[$pString];
        }
        //    It's surprising how costly the strtoupper() and ord() calls actually are, so we use a lookup array rather than use ord()
        //        and make it case insensitive to get rid of the strtoupper() as well. Because it's a static, there's no significant
        //        memory overhead either
        static $columnLookup = [
            'A' => 1, 'B' => 2, 'C' => 3, 'D' => 4, 'E' => 5, 'F' => 6, 'G' => 7, 'H' => 8, 'I' => 9, 'J' => 10, 'K' => 11, 'L' => 12, 'M' => 13,
            'N' => 14, 'O' => 15, 'P' => 16, 'Q' => 17, 'R' => 18, 'S' => 19, 'T' => 20, 'U' => 21, 'V' => 22, 'W' => 23, 'X' => 24, 'Y' => 25, 'Z' => 26,
            'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => 7, 'h' => 8, 'i' => 9, 'j' => 10, 'k' => 11, 'l' => 12, 'm' => 13,
            'n' => 14, 'o' => 15, 'p' => 16, 'q' => 17, 'r' => 18, 's' => 19, 't' => 20, 'u' => 21, 'v' => 22, 'w' => 23, 'x' => 24, 'y' => 25, 'z' => 26,
        ];
 
        //    We also use the language construct isset() rather than the more costly strlen() function to match the length of $pString
        //        for improved performance
        if (isset($pString[0])) {
            if (!isset($pString[1])) {
                $indexCache[$pString] = $columnLookup[$pString];
 
                return $indexCache[$pString];
            } elseif (!isset($pString[2])) {
                $indexCache[$pString] = $columnLookup[$pString[0]] * 26 + $columnLookup[$pString[1]];
 
                return $indexCache[$pString];
            } elseif (!isset($pString[3])) {
                $indexCache[$pString] = $columnLookup[$pString[0]] * 676 + $columnLookup[$pString[1]] * 26 + $columnLookup[$pString[2]];
 
                return $indexCache[$pString];
            }
        }
 
        throw new Exception('Column string index can not be ' . ((isset($pString[0])) ? 'longer than 3 characters' : 'empty'));
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\__construct(), PhpOffice\PhpSpreadsheet\Worksheet\ColumnCellIterator\__construct(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Offset\adjustEndCellColumnForWidth(), PhpOffice\PhpSpreadsheet\Writer\Html\buildCssPerSheet(), PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpansOmitRows(), PhpOffice\PhpSpreadsheet\ReferenceHelper\cellAddressInDeleteRange(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\RowColumnInformation\cellColumn(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\RowColumnInformation\COLUMN(), PhpOffice\PhpSpreadsheet\Cell\Cell\compareCells(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\evaluateDefinedName(), PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForCharts(), PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForChartsAndImages(), PhpOffice\PhpSpreadsheet\Writer\Html\generateTableHeader(), PhpOffice\PhpSpreadsheet\Shared\Xls\getDistanceX(), PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestColumn(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\getReferencesForCellBlock(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\indexesFromString(), PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore(), PhpOffice\PhpSpreadsheet\Cell\Cell\isInRange(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Offset\OFFSET(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\processTokenStack(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellAddressB(), PhpOffice\PhpSpreadsheet\Worksheet\ColumnIterator\resetEnd(), PhpOffice\PhpSpreadsheet\Worksheet\RowCellIterator\resetEnd(), PhpOffice\PhpSpreadsheet\Worksheet\ColumnIterator\resetStart(), PhpOffice\PhpSpreadsheet\Worksheet\RowCellIterator\resetStart(), PhpOffice\PhpSpreadsheet\Worksheet\ColumnIterator\seek(), PhpOffice\PhpSpreadsheet\Worksheet\RowCellIterator\seek(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\setRange(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\testColumnInRange(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReferencesAllWorksheets(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateColumnRangesAllWorksheets(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferences(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateSingleCellReference(), PhpOffice\PhpSpreadsheet\Writer\Ods\Settings\write(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\writeAllDefinedNamesBiff8(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeBreaks(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeBreaks(), PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeCellMerge(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCols(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeSelection(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetData(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetViews().

Here is the caller graph for this function:

coordinateFromString()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::coordinateFromString (   $pCoordinateString )

static

Coordinate from string.

Parameters

string

$pCoordinateString

eg: 'A1'

Returns

array{0: string, 1: string} Array containing column and row (indexes 0 and 1)

Definition at line 32 of file Coordinate.php.

    {
        if (preg_match(self::A1_COORDINATE_REGEX, $pCoordinateString, $matches)) {
            return [$matches['absolute_col'] . $matches['col_ref'], $matches['absolute_row'] . $matches['row_ref']];
        } elseif (self::coordinateIsRange($pCoordinateString)) {
            throw new Exception('Cell coordinate string can not be a range of cells');
        } elseif ($pCoordinateString == '') {
            throw new Exception('Cell coordinate can not be zero-length string');
        }
 
        throw new Exception('Invalid cell coordinate ' . $pCoordinateString);
    }

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\absoluteCoordinate(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustColumnDimensions(), PhpOffice\PhpSpreadsheet\ReferenceHelper\adjustRowDimensions(), PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\ReferenceHelper\cellAddressInDeleteRange(), PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForCharts(), PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForChartsAndImages(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\extractNamedRange(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\getRangeBoundaries(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\getReferencesForCellBlock(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\indexesFromString(), PhpOffice\PhpSpreadsheet\Reader\Xls\load(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\mergeRangesInCollection(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Offset\OFFSET(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\processTokenStack(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellAddressB(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellRange(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateFormulaReferences(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateSingleCellReference(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeBreaks(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeBreaks(), PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeCellMerge(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeSelection(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetData(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeSheetViews().

Here is the caller graph for this function:

coordinateIsRange()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::coordinateIsRange (   $coord )

static

Checks if a coordinate represents a range of cells.

Parameters

string

$coord

eg: 'A1' or 'A1:A2' or 'A1:A2,C1:C2'

Returns

bool Whether the coordinate represents a range of cells

Definition at line 69 of file Coordinate.php.

    {
        return (strpos($coord, ':') !== false) || (strpos($coord, ',') !== false);
    }

Referenced by PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellRange(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReference(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateSingleCellReference().

Here is the caller graph for this function:

extractAllCellReferencesInRange()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::extractAllCellReferencesInRange (   $cellRange )

static

Extract all cell references in range, which may be comprised of multiple cell ranges.

Parameters

string

$cellRange

Range: e.g. 'A1' or 'A1:C10' or 'A1:E10,A20:E25' or 'A1:E5 C3:G7' or 'A1:C1,A3:C3 B1:C3'

Returns

array Array containing single cell references

Definition at line 338 of file Coordinate.php.

                                                                      : array
    {
        [$ranges, $operators] = self::getCellBlocksFromRangeString($cellRange);
 
        $cells = [];
        foreach ($ranges as $range) {
            $cells[] = self::getReferencesForCellBlock($range);
        }
 
        $cells = self::processRangeSetOperators($operators, $cells);
 
        if (empty($cells)) {
            return [];
        }
 
        $cellList = array_merge(...$cells);
        $cellList = self::sortCellReferenceArray($cellList);
 
        return $cellList;
    }

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\getCellBlocksFromRangeString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\getReferencesForCellBlock(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\processRangeSetOperators(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\sortCellReferenceArray().

Referenced by PhpOffice\PhpSpreadsheet\Calculation\Calculation\extractCellRange(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\extractNamedRange(), PhpOffice\PhpSpreadsheet\NamedRange\getCellsInRange(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\DataValidations\load(), PhpOffice\PhpSpreadsheet\Reader\Html\processDomElementThTd(), PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation(), PhpOffice\PhpSpreadsheet\Reader\Xls\readHyperLink(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Hyperlinks\setHyperlink().

Here is the call graph for this function:

Here is the caller graph for this function:

getCellBlocksFromRangeString()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::getCellBlocksFromRangeString (   $rangeString )

staticprivate

Get the individual cell blocks from a range string, removing any $ characters.

then splitting by operators and returning an array with ranges and operators.

Parameters

string

$rangeString

Returns

array[]

Definition at line 540 of file Coordinate.php.

    {
        $rangeString = str_replace('$', '', strtoupper($rangeString));
 
        // split range sets on intersection (space) or union (,) operators
        $tokens = preg_split('/([ ,])/', $rangeString, -1, PREG_SPLIT_DELIM_CAPTURE);
        // separate the range sets and the operators into arrays
        $split = array_chunk($tokens, 2);
        $ranges = array_column($split, 0);
        $operators = array_column($split, 1);
 
        return [$ranges, $operators];
    }

References PREG_SPLIT_DELIM_CAPTURE.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\extractAllCellReferencesInRange().

Here is the caller graph for this function:

getRangeBoundaries()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::getRangeBoundaries (   $pRange )

static

Calculate range boundaries.

Parameters

string

$pRange

Cell range (e.g. A1:A1)

Returns

array Range coordinates [Start Cell, End Cell] where Start Cell and End Cell are arrays [Column ID, Row Number]

Definition at line 238 of file Coordinate.php.

    {
        // Ensure $pRange is a valid range
        if (empty($pRange)) {
            $pRange = self::DEFAULT_RANGE;
        }
 
        // Uppercase coordinate
        $pRange = strtoupper($pRange);
 
        // Extract range
        if (strpos($pRange, ':') === false) {
            $rangeA = $rangeB = $pRange;
        } else {
            [$rangeA, $rangeB] = explode(':', $pRange);
        }
 
        return [self::coordinateFromString($rangeA), self::coordinateFromString($rangeB)];
    }

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\DEFAULT_RANGE.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\includeCellRangeFiltered().

Here is the call graph for this function:

Here is the caller graph for this function:

getReferencesForCellBlock()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::getReferencesForCellBlock (   $cellBlock )

staticprivate

Get all cell references for an individual cell block.

Parameters

string

$cellBlock

A cell range e.g. A4:B5

Returns

array All individual cells in that range

Definition at line 399 of file Coordinate.php.

    {
        $returnValue = [];
 
        // Single cell?
        if (!self::coordinateIsRange($cellBlock)) {
            return (array) $cellBlock;
        }
 
        // Range...
        $ranges = self::splitRange($cellBlock);
        foreach ($ranges as $range) {
            // Single cell?
            if (!isset($range[1])) {
                $returnValue[] = $range[0];
 
                continue;
            }
 
            // Range...
            [$rangeStart, $rangeEnd] = $range;
            [$startColumn, $startRow] = self::coordinateFromString($rangeStart);
            [$endColumn, $endRow] = self::coordinateFromString($rangeEnd);
            $startColumnIndex = self::columnIndexFromString($startColumn);
            $endColumnIndex = self::columnIndexFromString($endColumn);
            ++$endColumnIndex;
 
            // Current data
            $currentColumnIndex = $startColumnIndex;
            $currentRow = $startRow;
 
            self::validateRange($cellBlock, $startColumnIndex, $endColumnIndex, $currentRow, $endRow);
 
            // Loop cells
            while ($currentColumnIndex < $endColumnIndex) {
                while ($currentRow <= $endRow) {
                    $returnValue[] = self::stringFromColumnIndex($currentColumnIndex) . $currentRow;
                    ++$currentRow;
                }
                ++$currentColumnIndex;
                $currentRow = $startRow;
            }
        }
 
        return $returnValue;
    }

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\splitRange(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\validateRange().

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\extractAllCellReferencesInRange().

Here is the call graph for this function:

Here is the caller graph for this function:

indexesFromString()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::indexesFromString ( string  $coordinates )

static

Get indexes from a string coordinates.

Parameters

string

$coordinates

eg: 'A1', '$B$12'

Returns

array{0: int, 1: int} Array containing column index and row index (indexes 0 and 1)

Definition at line 52 of file Coordinate.php.

                                                                 : array
    {
        [$col, $row] = self::coordinateFromString($coordinates);
 
        return [
            self::columnIndexFromString(ltrim($col, '$')),
            (int) ltrim($row, '$'),
        ];
    }

References $row, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString().

Referenced by PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\castToFormula(), PhpOffice\PhpSpreadsheet\Writer\Xls\Escher\close(), PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData(), PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore(), PhpOffice\PhpSpreadsheet\Shared\Xls\oneAnchor2twoAnchor(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellRangeAddressB(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\writeAllDefinedNamesBiff8(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeBIFF8CellRangeAddressFixed(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeChart(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Drawing\writeDrawing(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeMergedCells(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writePanes(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

Here is the call graph for this function:

Here is the caller graph for this function:

mergeRangesInCollection()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::mergeRangesInCollection ( array  $pCoordCollection )

static

Convert an associative array of single cell coordinates to values to an associative array of cell ranges to values.

Only adjacent cell coordinates with the same value will be merged. If the value is an object, it must implement the method getHashCode().

For example, this function converts:

[ 'A1' => 'x', 'A2' => 'x', 'A3' => 'x', 'A4' => 'y' ]

to:

[ 'A1:A3' => 'x', 'A4' => 'y' ]

Parameters

array

$pCoordCollection

associative array mapping coordinates to values

Returns

array associative array mapping coordinate ranges to valuea

Definition at line 463 of file Coordinate.php.

    {
        $hashedValues = [];
        $mergedCoordCollection = [];
 
        foreach ($pCoordCollection as $coord => $value) {
            if (self::coordinateIsRange($coord)) {
                $mergedCoordCollection[$coord] = $value;
 
                continue;
            }
 
            [$column, $row] = self::coordinateFromString($coord);
            $row = (int) (ltrim($row, '$'));
            $hashCode = $column . '-' . (is_object($value) ? $value->getHashCode() : $value);
 
            if (!isset($hashedValues[$hashCode])) {
                $hashedValues[$hashCode] = (object) [
                    'value' => $value,
                    'col' => $column,
                    'rows' => [$row],
                ];
            } else {
                $hashedValues[$hashCode]->rows[] = $row;
            }
        }
 
        ksort($hashedValues);
 
        foreach ($hashedValues as $hashedValue) {
            sort($hashedValue->rows);
            $rowStart = null;
            $rowEnd = null;
            $ranges = [];
 
            foreach ($hashedValue->rows as $row) {
                if ($rowStart === null) {
                    $rowStart = $row;
                    $rowEnd = $row;
                } elseif ($rowEnd === $row - 1) {
                    $rowEnd = $row;
                } else {
                    if ($rowStart == $rowEnd) {
                        $ranges[] = $hashedValue->col . $rowStart;
                    } else {
                        $ranges[] = $hashedValue->col . $rowStart . ':' . $hashedValue->col . $rowEnd;
                    }
 
                    $rowStart = $row;
                    $rowEnd = $row;
                }
            }
 
            if ($rowStart !== null) {
                if ($rowStart == $rowEnd) {
                    $ranges[] = $hashedValue->col . $rowStart;
                } else {
                    $ranges[] = $hashedValue->col . $rowStart . ':' . $hashedValue->col . $rowEnd;
                }
            }
 
            foreach ($ranges as $range) {
                $mergedCoordCollection[$range] = $hashedValue->value;
            }
        }
 
        return $mergedCoordCollection;
    }

References $row, and PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeDataValidations().

Here is the call graph for this function:

Here is the caller graph for this function:

processRangeSetOperators()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::processRangeSetOperators ( array  $operators, array  $cells  )

staticprivate

Definition at line 359 of file Coordinate.php.

                                                                                    : array
    {
        $operatorCount = count($operators);
        for ($offset = 0; $offset < $operatorCount; ++$offset) {
            $operator = $operators[$offset];
            if ($operator !== ' ') {
                continue;
            }
 
            $cells[$offset] = array_intersect($cells[$offset], $cells[$offset + 1]);
            unset($operators[$offset], $cells[$offset + 1]);
            $operators = array_values($operators);
            $cells = array_values($cells);
            --$offset;
            --$operatorCount;
        }
 
        return $cells;
    }

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\extractAllCellReferencesInRange().

Here is the caller graph for this function:

rangeBoundaries()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::rangeBoundaries (   $pRange )

static

Calculate range boundaries.

Parameters

string

$pRange

Cell range (e.g. A1:A1)

Returns

array Range coordinates [Start Cell, End Cell] where Start Cell and End Cell are arrays (Column Number, Row Number)

Definition at line 187 of file Coordinate.php.

    {
        // Ensure $pRange is a valid range
        if (empty($pRange)) {
            $pRange = self::DEFAULT_RANGE;
        }
 
        // Uppercase coordinate
        $pRange = strtoupper($pRange);
 
        // Extract range
        if (strpos($pRange, ':') === false) {
            $rangeA = $rangeB = $pRange;
        } else {
            [$rangeA, $rangeB] = explode(':', $pRange);
        }
 
        // Calculate range outer borders
        $rangeStart = self::coordinateFromString($rangeA);
        $rangeEnd = self::coordinateFromString($rangeB);
 
        // Translate column into index
        $rangeStart[0] = self::columnIndexFromString($rangeStart[0]);
        $rangeEnd[0] = self::columnIndexFromString($rangeEnd[0]);
 
        return [$rangeStart, $rangeEnd];
    }

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\DEFAULT_RANGE.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\buildWorksheetEschers(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\getColumnByOffset(), PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore(), PhpOffice\PhpSpreadsheet\Cell\Cell\isInRange(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeDimension(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\setRange(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\showHideRows(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\testColumnInRange(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\writeAllDefinedNamesBiff8(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeAutoFilterInfo(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

rangeDimension()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::rangeDimension (   $pRange )

static

Calculate range dimension.

Parameters

string

$pRange

Cell range (e.g. A1:A1)

Returns

array Range dimension (width, height)

Definition at line 222 of file Coordinate.php.

    {
        // Calculate range outer borders
        [$rangeStart, $rangeEnd] = self::rangeBoundaries($pRange);
 
        return [($rangeEnd[0] - $rangeStart[0] + 1), ($rangeEnd[1] - $rangeStart[1] + 1)];
    }

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries().

Referenced by PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues\refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

sortCellReferenceArray()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::sortCellReferenceArray ( array  $cellList )

staticprivate

Definition at line 379 of file Coordinate.php.

                                                                   : array
    {
        //    Sort the result by column and row
        $sortKeys = [];
        foreach ($cellList as $coord) {
            [$column, $row] = sscanf($coord, '%[A-Z]%d');
            $sortKeys[sprintf('%3s%09d', $column, $row)] = $coord;
        }
        ksort($sortKeys);
 
        return array_values($sortKeys);
    }

References $row.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\extractAllCellReferencesInRange().

Here is the caller graph for this function:

splitRange()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::splitRange (   $pRange )

static

Split range into coordinate strings.

Parameters

string

$pRange

e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'

Returns

array Array containing one or more arrays containing one or two coordinate strings e.g. ['B4','D9'] or [['B4','D9'], ['H2','O11']] or ['B4']

Definition at line 140 of file Coordinate.php.

    {
        // Ensure $pRange is a valid range
        if (empty($pRange)) {
            $pRange = self::DEFAULT_RANGE;
        }
 
        $exploded = explode(',', $pRange);
        $counter = count($exploded);
        for ($i = 0; $i < $counter; ++$i) {
            $exploded[$i] = explode(':', $exploded[$i]);
        }
 
        return $exploded;
    }

References $i, and PhpOffice\PhpSpreadsheet\Cell\Coordinate\DEFAULT_RANGE.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\extractNamedRange(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\getReferencesForCellBlock(), PhpOffice\PhpSpreadsheet\Cell\Cell\isMergeRangeValueCell(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellRange(), PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook\writeAllDefinedNamesBiff8(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeAutoFilter(), PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeCellMerge(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeMergedCells(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames\writeNamedRangeForAutofilter(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeSelection().

Here is the caller graph for this function:

stringFromColumnIndex()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex (   $columnIndex )

static

String from column index.

Parameters

int

$columnIndex

Column index (A = 1)

Returns

string

Definition at line 313 of file Coordinate.php.

    {
        static $indexCache = [];
 
        if (!isset($indexCache[$columnIndex])) {
            $indexValue = $columnIndex;
            $base26 = null;
            do {
                $characterValue = ($indexValue % 26) ?: 26;
                $indexValue = ($indexValue - $characterValue) / 26;
                $base26 = chr($characterValue + 64) . ($base26 ?: '');
            } while ($indexValue > 0);
            $indexCache[$columnIndex] = $base26;
        }
 
        return $indexCache[$columnIndex];
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Slk\addFonts(), PhpOffice\PhpSpreadsheet\Reader\Slk\addFormats(), PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\addPrintAreaByColumnAndRow(), PhpOffice\PhpSpreadsheet\Reader\Slk\addStyle(), PhpOffice\PhpSpreadsheet\Reader\Slk\addWidth(), PhpOffice\PhpSpreadsheet\Style\Style\applyFromArray(), PhpOffice\PhpSpreadsheet\Writer\Xls\buildWorksheetEschers(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\PageSetup\columnBreaks(), PhpOffice\PhpSpreadsheet\Worksheet\ColumnIterator\current(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Address\formatAsA1(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRow(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellCss(), PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData(), PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\getColumnByOffset(), PhpOffice\PhpSpreadsheet\Shared\Xls\getDistanceX(), PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestColumn(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\getReferencesForCellBlock(), PhpOffice\PhpSpreadsheet\ReferenceHelper\insertNewBefore(), PhpOffice\PhpSpreadsheet\Worksheet\ColumnIterator\key(), PhpOffice\PhpSpreadsheet\Worksheet\RowCellIterator\key(), PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Slk\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Xls\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Csv\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\loadIntoExisting(), PhpOffice\PhpSpreadsheet\Calculation\LookupRef\Offset\OFFSET(), PhpOffice\PhpSpreadsheet\Shared\Xls\oneAnchor2twoAnchor(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\SheetViews\pane(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\positionImage(), PhpOffice\PhpSpreadsheet\Reader\Slk\processCRecord(), PhpOffice\PhpSpreadsheet\Reader\Slk\processFormula(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\processTokenStack(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF5CellRangeAddressFixed(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellAddress(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellAddressB(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellRangeAddress(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellRangeAddressB(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBIFF8CellRangeAddressFixed(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBlank(), PhpOffice\PhpSpreadsheet\Reader\Xls\readBoolErr(), PhpOffice\PhpSpreadsheet\Reader\Xls\Escher\readClientAnchor(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\ColumnAndRowAttributes\readColumnAttributes(), PhpOffice\PhpSpreadsheet\Reader\Xls\readFormula(), PhpOffice\PhpSpreadsheet\Reader\Xls\readLabel(), PhpOffice\PhpSpreadsheet\Reader\Xls\readLabelSst(), PhpOffice\PhpSpreadsheet\Reader\Xls\readMulBlank(), PhpOffice\PhpSpreadsheet\Reader\Xls\readMulRk(), PhpOffice\PhpSpreadsheet\Reader\Xls\readNumber(), PhpOffice\PhpSpreadsheet\Reader\Xls\readPane(), PhpOffice\PhpSpreadsheet\Reader\Xls\readRk(), PhpOffice\PhpSpreadsheet\Worksheet\RowCellIterator\resetStart(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\setColumnInvisible(), PhpOffice\PhpSpreadsheet\Reader\Gnumeric\setColumnWidth(), PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\setPrintAreaByColumnAndRow(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateCellReferencesAllWorksheets(), PhpOffice\PhpSpreadsheet\ReferenceHelper\updateColumnRangesAllWorksheets(), and PhpOffice\PhpSpreadsheet\ReferenceHelper\updateSingleCellReference().

Here is the caller graph for this function:

validateRange()

static PhpOffice\PhpSpreadsheet\Cell\Coordinate::validateRange (   $cellBlock,   $startColumnIndex,   $endColumnIndex,   $currentRow,   $endRow  )

staticprivate

Check that the given range is valid, i.e.

that the start column and row are not greater than the end column and row.

Parameters

string	$cellBlock	The original range, for displaying a meaningful error message
int	$startColumnIndex
int	$endColumnIndex
int	$currentRow
int	$endRow

Definition at line 564 of file Coordinate.php.

                                                                                                               : void
    {
        if ($startColumnIndex >= $endColumnIndex || $currentRow > $endRow) {
            throw new Exception('Invalid range: "' . $cellBlock . '"');
        }
    }

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\getReferencesForCellBlock().

Here is the caller graph for this function:

Field Documentation

A1_COORDINATE_REGEX

const PhpOffice\PhpSpreadsheet\Cell\Coordinate::A1_COORDINATE_REGEX = '/^(?<absolute_col>\$?)(?<col_ref>[A-Z]{1,3})(?<absolute_row>\$?)(?<row_ref>\d{1,7})$/i'

Definition at line 16 of file Coordinate.php.

DEFAULT_RANGE

const PhpOffice\PhpSpreadsheet\Cell\Coordinate::DEFAULT_RANGE = 'A1:A1'

Definition at line 23 of file Coordinate.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\Coordinate\getRangeBoundaries(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\splitRange().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Cell/Coordinate.php