Collaboration diagram for PhpOffice\PhpSpreadsheet\Collection\Cells:

Public Member Functions
	__construct (Worksheet $parent, CacheInterface $cache)
	Initialise this new cell collection. More...

	getParent ()
	Return the parent worksheet for this cell collection. More...

	has ($pCoord)
	Whether the collection holds a cell for the given coordinate. More...

	update (Cell $cell)
	Add or update a cell in the collection. More...

	delete ($pCoord)
	Delete a cell in cache identified by coordinate. More...

	getCoordinates ()
	Get a list of all cell coordinates currently held in the collection. More...

	getSortedCoordinates ()
	Get a sorted list of all cell coordinates currently held in the collection by row and column. More...

	getHighestRowAndColumn ()
	Get highest worksheet column and highest row that have cell records. More...

	getCurrentCoordinate ()
	Return the cell coordinate of the currently active cell object. More...

	getCurrentColumn ()
	Return the column coordinate of the currently active cell object. More...

	getCurrentRow ()
	Return the row coordinate of the currently active cell object. More...

	getHighestColumn ($row=null)
	Get highest worksheet column. More...

	getHighestRow ($column=null)
	Get highest worksheet row. More...

	cloneCellCollection (Worksheet $parent)
	Clone the cell collection. More...

	removeRow ($row)
	Remove a row, deleting all cells in that row. More...

	removeColumn ($column)
	Remove a column, deleting all cells in that column. More...

	add ($pCoord, Cell $cell)
	Add or update a cell identified by its coordinate into the collection. More...

	get ($pCoord)
	Get cell at a specific coordinate. More...

	unsetWorksheetCells ()
	Clear the cell collection and disconnect from our parent. More...

	__destruct ()
	Destroy this cell collection. More...

Private Member Functions
	getUniqueID ()
	Generate a unique ID for cache referencing. More...

	storeCurrentCell ()
	Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current cell object. More...

	getAllCacheKeys ()
	Returns all known cache keys. More...

Private Attributes
	$cache

	$parent

	$currentCell

	$currentCoordinate

	$currentCellIsDirty = false

	$index = []

	$cachePrefix

Detailed Description

Definition at line 12 of file Cells.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Collection\Cells::__construct	(	Worksheet	$parent,
		CacheInterface	$cache
	)

Initialise this new cell collection.

Parameters

Worksheet $parent The worksheet for this cell collection

Definition at line 66 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\$cache, PhpOffice\PhpSpreadsheet\Collection\Cells\$parent, and PhpOffice\PhpSpreadsheet\Collection\Cells\getUniqueID().

     {
         // Set our parent worksheet.
         // This is maintained here to facilitate re-attaching it to Cell objects when
         // they are woken from a serialized state
         $this->parent = $parent;
         $this->cache = $cache;
         $this->cachePrefix = $this->getUniqueID();
     }

Here is the call graph for this function:

◆ __destruct()

PhpOffice\PhpSpreadsheet\Collection\Cells::__destruct ( )

Destroy this cell collection.

Definition at line 482 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\getAllCacheKeys().

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\storeCurrentCell(), and PhpOffice\PhpSpreadsheet\Collection\Cells\unsetWorksheetCells().

     {
         $this->cache->deleteMultiple($this->getAllCacheKeys());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ add()

PhpOffice\PhpSpreadsheet\Collection\Cells::add	(		$pCoord,
		Cell	$cell
	)

Add or update a cell identified by its coordinate into the collection.

Parameters

string	$pCoord	Coordinate of the cell to update
Cell	$cell	Cell to update

Returns: Cell

Definition at line 410 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\storeCurrentCell().

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\update().

     {
         if ($pCoord !== $this->currentCoordinate) {
             $this->storeCurrentCell();
         }
         $this->index[$pCoord] = true;
 
         $this->currentCoordinate = $pCoord;
         $this->currentCell = $cell;
         $this->currentCellIsDirty = true;
 
         return $cell;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneCellCollection()

PhpOffice\PhpSpreadsheet\Collection\Cells::cloneCellCollection ( Worksheet $parent )

Clone the cell collection.

Parameters

Worksheet $parent The new worksheet that we're copying to

Returns: self

Definition at line 311 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\$parent, and PhpOffice\PhpSpreadsheet\Collection\Cells\storeCurrentCell().

     {
         $this->storeCurrentCell();
         $newCollection = clone $this;
 
         $newCollection->parent = $parent;
         if (($newCollection->currentCell !== null) && (is_object($newCollection->currentCell))) {
             $newCollection->currentCell->attach($this);
         }
 
         // Get old values
         $oldKeys = $newCollection->getAllCacheKeys();
         $oldValues = $newCollection->cache->getMultiple($oldKeys);
         $newValues = [];
         $oldCachePrefix = $newCollection->cachePrefix;
 
         // Change prefix
         $newCollection->cachePrefix = $newCollection->getUniqueID();
         foreach ($oldValues as $oldKey => $value) {
             $newValues[str_replace($oldCachePrefix, $newCollection->cachePrefix, $oldKey)] = clone $value;
         }
 
         // Store new values
         $stored = $newCollection->cache->setMultiple($newValues);
         if (!$stored) {
             $newCollection->__destruct();
 
             throw new PhpSpreadsheetException('Failed to copy cells in cache');
         }
 
         return $newCollection;
     }

Here is the call graph for this function:

◆ delete()

PhpOffice\PhpSpreadsheet\Collection\Cells::delete ( $pCoord )

Delete a cell in cache identified by coordinate.

Parameters

string $pCoord Coordinate of the cell to delete

Definition at line 120 of file Cells.php.

                                    : void
     {
         if ($pCoord === $this->currentCoordinate && $this->currentCell !== null) {
             $this->currentCell->detach();
             $this->currentCoordinate = null;
             $this->currentCell = null;
             $this->currentCellIsDirty = false;
         }
 
         unset($this->index[$pCoord]);
 
         // Delete the entry from cache
         $this->cache->delete($this->cachePrefix . $pCoord);
     }

◆ get()

PhpOffice\PhpSpreadsheet\Collection\Cells::get ( $pCoord )

Get cell at a specific coordinate.

Parameters

string $pCoord Coordinate of the cell

Returns: null|Cell Cell that was found, or null if not found

Definition at line 431 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\$currentCell, PhpOffice\PhpSpreadsheet\Collection\Cells\has(), and PhpOffice\PhpSpreadsheet\Collection\Cells\storeCurrentCell().

     {
         if ($pCoord === $this->currentCoordinate) {
             return $this->currentCell;
         }
         $this->storeCurrentCell();
 
         // Return null if requested entry doesn't exist in collection
         if (!$this->has($pCoord)) {
             return null;
         }
 
         // Check if the entry that has been requested actually exists
         $cell = $this->cache->get($this->cachePrefix . $pCoord);
         if ($cell === null) {
             throw new PhpSpreadsheetException("Cell entry {$pCoord} no longer exists in cache. This probably means that the cache was cleared by someone else.");
         }
 
         // Set current entry to the requested entry
         $this->currentCoordinate = $pCoord;
         $this->currentCell = $cell;
         // Re-attach this as the cell's parent
         $this->currentCell->attach($this);
 
         // Return requested entry
         return $this->currentCell;
     }

Here is the call graph for this function:

◆ getAllCacheKeys()

PhpOffice\PhpSpreadsheet\Collection\Cells::getAllCacheKeys ( )

private

Returns all known cache keys.

Returns: Generator|string[]

Definition at line 492 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates().

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\__destruct().

     {
         foreach ($this->getCoordinates() as $coordinate) {
             yield $this->cachePrefix . $coordinate;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCoordinates()

PhpOffice\PhpSpreadsheet\Collection\Cells::getCoordinates ( )

Get a list of all cell coordinates currently held in the collection.

Returns: string[]

Definition at line 140 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\getAllCacheKeys(), PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestColumn(), PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestRow(), PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestRowAndColumn(), PhpOffice\PhpSpreadsheet\Collection\Cells\getSortedCoordinates(), PhpOffice\PhpSpreadsheet\Collection\Cells\removeColumn(), and PhpOffice\PhpSpreadsheet\Collection\Cells\removeRow().

     {
         return array_keys($this->index);
     }

Here is the caller graph for this function:

◆ getCurrentColumn()

PhpOffice\PhpSpreadsheet\Collection\Cells::getCurrentColumn ( )

Return the column coordinate of the currently active cell object.

Returns: string

Definition at line 207 of file Cells.php.

References $row.

     {
         $column = '';
         $row = 0;
 
         sscanf($this->currentCoordinate, '%[A-Z]%d', $column, $row);
 
         return $column;
     }

◆ getCurrentCoordinate()

PhpOffice\PhpSpreadsheet\Collection\Cells::getCurrentCoordinate ( )

Return the cell coordinate of the currently active cell object.

Returns: string

Definition at line 197 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\$currentCoordinate.

     {
         return $this->currentCoordinate;
     }

◆ getCurrentRow()

PhpOffice\PhpSpreadsheet\Collection\Cells::getCurrentRow ( )

Return the row coordinate of the currently active cell object.

Returns: int

Definition at line 222 of file Cells.php.

References $row.

     {
         $column = '';
         $row = 0;
 
         sscanf($this->currentCoordinate, '%[A-Z]%d', $column, $row);
 
         return (int) $row;
     }

◆ getHighestColumn()

PhpOffice\PhpSpreadsheet\Collection\Cells::getHighestColumn ( $row = null )

Get highest worksheet column.

Parameters

string $row Return the highest column for the specified row, or the highest column of any row if no row number is passed

Returns: string Highest column name

Definition at line 240 of file Cells.php.

References $c, $r, $row, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates(), PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestRowAndColumn(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

     {
         if ($row === null) {
             $colRow = $this->getHighestRowAndColumn();
 
             return $colRow['column'];
         }
 
         $columnList = [1];
         foreach ($this->getCoordinates() as $coord) {
             $c = '';
             $r = 0;
 
             sscanf($coord, '%[A-Z]%d', $c, $r);
             if ($r != $row) {
                 continue;
             }
             $columnList[] = Coordinate::columnIndexFromString($c);
         }
 
         return Coordinate::stringFromColumnIndex(max($columnList));
     }

Here is the call graph for this function:

◆ getHighestRow()

PhpOffice\PhpSpreadsheet\Collection\Cells::getHighestRow ( $column = null )

Get highest worksheet row.

Parameters

string $column Return the highest row for the specified column, or the highest row of any column if no column letter is passed

Returns: int Highest row number

Definition at line 271 of file Cells.php.

References $c, $r, PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates(), and PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestRowAndColumn().

     {
         if ($column === null) {
             $colRow = $this->getHighestRowAndColumn();
 
             return $colRow['row'];
         }
 
         $rowList = [0];
         foreach ($this->getCoordinates() as $coord) {
             $c = '';
             $r = 0;
 
             sscanf($coord, '%[A-Z]%d', $c, $r);
             if ($c != $column) {
                 continue;
             }
             $rowList[] = $r;
         }
 
         return max($rowList);
     }

Here is the call graph for this function:

◆ getHighestRowAndColumn()

PhpOffice\PhpSpreadsheet\Collection\Cells::getHighestRowAndColumn ( )

Get highest worksheet column and highest row that have cell records.

Returns: array Highest column name and highest row number

Definition at line 169 of file Cells.php.

References $c, $r, $row, and PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates().

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestColumn(), and PhpOffice\PhpSpreadsheet\Collection\Cells\getHighestRow().

     {
         // Lookup highest column and highest row
         $col = ['A' => '1A'];
         $row = [1];
         foreach ($this->getCoordinates() as $coord) {
             $c = '';
             $r = 0;
             sscanf($coord, '%[A-Z]%d', $c, $r);
             $row[$r] = $r;
             $col[$c] = strlen($c) . $c;
         }
 
         // Determine highest column and row
         $highestRow = max($row);
         $highestColumn = substr(max($col), 1);
 
         return [
             'row' => $highestRow,
             'column' => $highestColumn,
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

PhpOffice\PhpSpreadsheet\Collection\Cells::getParent ( )

Return the parent worksheet for this cell collection.

Returns: Worksheet

Definition at line 81 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\$parent.

     {
         return $this->parent;
     }

◆ getSortedCoordinates()

PhpOffice\PhpSpreadsheet\Collection\Cells::getSortedCoordinates ( )

Get a sorted list of all cell coordinates currently held in the collection by row and column.

Returns: string[]

Definition at line 150 of file Cells.php.

References $row, and PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates().

     {
         $sortKeys = [];
         foreach ($this->getCoordinates() as $coord) {
             $column = '';
             $row = 0;
             sscanf($coord, '%[A-Z]%d', $column, $row);
             $sortKeys[sprintf('%09d%3s', $row, $column)] = $coord;
         }
         ksort($sortKeys);
 
         return array_values($sortKeys);
     }

Here is the call graph for this function:

◆ getUniqueID()

PhpOffice\PhpSpreadsheet\Collection\Cells::getUniqueID ( )

private

Generate a unique ID for cache referencing.

Returns: string Unique Reference

Definition at line 299 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\__construct().

     {
         return uniqid('phpspreadsheet.', true) . '.';
     }

Here is the caller graph for this function:

◆ has()

PhpOffice\PhpSpreadsheet\Collection\Cells::has ( $pCoord )

Whether the collection holds a cell for the given coordinate.

Parameters

string $pCoord Coordinate of the cell to check

Returns: bool

Definition at line 93 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\get().

     {
         if ($pCoord === $this->currentCoordinate) {
             return true;
         }
 
         // Check if the requested entry exists in the index
         return isset($this->index[$pCoord]);
     }

Here is the caller graph for this function:

◆ removeColumn()

PhpOffice\PhpSpreadsheet\Collection\Cells::removeColumn ( $column )

Remove a column, deleting all cells in that column.

Parameters

string $column Column ID to remove

Definition at line 367 of file Cells.php.

References $c, $r, and PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates().

                                          : void
     {
         foreach ($this->getCoordinates() as $coord) {
             $c = '';
             $r = 0;
 
             sscanf($coord, '%[A-Z]%d', $c, $r);
             if ($c == $column) {
                 $this->delete($coord);
             }
         }
     }

Here is the call graph for this function:

◆ removeRow()

PhpOffice\PhpSpreadsheet\Collection\Cells::removeRow ( $row )

Remove a row, deleting all cells in that row.

Parameters

string $row Row number to remove

Definition at line 349 of file Cells.php.

References $c, $r, $row, and PhpOffice\PhpSpreadsheet\Collection\Cells\getCoordinates().

                                    : void
     {
         foreach ($this->getCoordinates() as $coord) {
             $c = '';
             $r = 0;
 
             sscanf($coord, '%[A-Z]%d', $c, $r);
             if ($r == $row) {
                 $this->delete($coord);
             }
         }
     }

Here is the call graph for this function:

◆ storeCurrentCell()

PhpOffice\PhpSpreadsheet\Collection\Cells::storeCurrentCell ( )

private

Store cell data in cache for the current cell object if it's "dirty", and the 'nullify' the current cell object.

Definition at line 384 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\__destruct().

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\add(), PhpOffice\PhpSpreadsheet\Collection\Cells\cloneCellCollection(), and PhpOffice\PhpSpreadsheet\Collection\Cells\get().

                                        : void
     {
         if ($this->currentCellIsDirty && !empty($this->currentCoordinate)) {
             $this->currentCell->detach();
 
             $stored = $this->cache->set($this->cachePrefix . $this->currentCoordinate, $this->currentCell);
             if (!$stored) {
                 $this->__destruct();
 
                 throw new PhpSpreadsheetException("Failed to store cell {$this->currentCoordinate} in cache");
             }
             $this->currentCellIsDirty = false;
         }
 
         $this->currentCoordinate = null;
         $this->currentCell = null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsetWorksheetCells()

PhpOffice\PhpSpreadsheet\Collection\Cells::unsetWorksheetCells ( )

Clear the cell collection and disconnect from our parent.

Definition at line 462 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\__destruct().

                                          : void
     {
         if ($this->currentCell !== null) {
             $this->currentCell->detach();
             $this->currentCell = null;
             $this->currentCoordinate = null;
         }
 
         // Flush the cache
         $this->__destruct();
 
         $this->index = [];
 
         // detach ourself from the worksheet, so that it can then delete this object successfully
         $this->parent = null;
     }

Here is the call graph for this function:

◆ update()

PhpOffice\PhpSpreadsheet\Collection\Cells::update ( Cell $cell )

Add or update a cell in the collection.

Parameters

Cell $cell Cell to update

Returns: Cell

Definition at line 110 of file Cells.php.

References PhpOffice\PhpSpreadsheet\Collection\Cells\add(), and PhpOffice\PhpSpreadsheet\Cell\Cell\getCoordinate().

     {
         return $this->add($cell->getCoordinate(), $cell);
     }

Here is the call graph for this function:

Field Documentation

◆ $cache

PhpOffice\PhpSpreadsheet\Collection\Cells::$cache

private

Definition at line 17 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\__construct().

◆ $cachePrefix

PhpOffice\PhpSpreadsheet\Collection\Cells::$cachePrefix

private

Definition at line 59 of file Cells.php.

◆ $currentCell

PhpOffice\PhpSpreadsheet\Collection\Cells::$currentCell

private

Definition at line 31 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\get().

◆ $currentCellIsDirty

PhpOffice\PhpSpreadsheet\Collection\Cells::$currentCellIsDirty = false

private

Definition at line 45 of file Cells.php.

◆ $currentCoordinate

PhpOffice\PhpSpreadsheet\Collection\Cells::$currentCoordinate

private

Definition at line 38 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\getCurrentCoordinate().

◆ $index

PhpOffice\PhpSpreadsheet\Collection\Cells::$index = []

private

Definition at line 52 of file Cells.php.

◆ $parent

PhpOffice\PhpSpreadsheet\Collection\Cells::$parent

private

Definition at line 24 of file Cells.php.

Referenced by PhpOffice\PhpSpreadsheet\Collection\Cells\__construct(), PhpOffice\PhpSpreadsheet\Collection\Cells\cloneCellCollection(), and PhpOffice\PhpSpreadsheet\Collection\Cells\getParent().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Collection/Cells.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ add()

◆ cloneCellCollection()

◆ delete()

◆ get()

◆ getAllCacheKeys()

◆ getCoordinates()

◆ getCurrentColumn()

◆ getCurrentCoordinate()

◆ getCurrentRow()

◆ getHighestColumn()

◆ getHighestRow()

◆ getHighestRowAndColumn()

◆ getParent()

◆ getSortedCoordinates()

◆ getUniqueID()

◆ has()

◆ removeColumn()

◆ removeRow()

◆ storeCurrentCell()

◆ unsetWorksheetCells()

◆ update()

Field Documentation

◆ $cache

◆ $cachePrefix

◆ $currentCell

◆ $currentCellIsDirty

◆ $currentCoordinate

◆ $index

◆ $parent