PhpOffice\PhpSpreadsheet\Collection\Memory Class Reference

This is the default implementation for in-memory cell collection. More...

Inheritance diagram for PhpOffice\PhpSpreadsheet\Collection\Memory:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Collection\Memory:

Public Member Functions
	clear ()
	Wipes clean the entire cache's keys. More...
	delete ($key)
	Delete an item from the cache by its unique key. More...
	deleteMultiple ($keys)
	Deletes multiple cache items in a single operation. More...
	get ($key, $default=null)
	Fetches a value from the cache. More...
	getMultiple ($keys, $default=null)
	Obtains multiple cache items by their unique keys. More...
	has ($key)
	Determines whether an item is present in the cache. More...
	set ($key, $value, $ttl=null)
	Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time. More...
	setMultiple ($values, $ttl=null)
	Persists a set of key => value pairs in the cache, with an optional TTL. More...

Private Attributes
	$cache = []

Detailed Description

This is the default implementation for in-memory cell collection.

Alternatives implementation should leverage off-memory, non-volatile storage to reduce overall memory usage.

Definition at line 13 of file Memory.php.

Member Function Documentation

clear()

PhpOffice\PhpSpreadsheet\Collection\Memory::clear

(

)

Wipes clean the entire cache's keys.

Returns

bool True on success and false on failure.

Implements Psr\SimpleCache\CacheInterface.

Definition at line 17 of file Memory.php.

    {
        $this->cache = [];

        return true;
    }

delete()

PhpOffice\PhpSpreadsheet\Collection\Memory::delete

(

$key

)

Delete an item from the cache by its unique key.

Parameters

string

$key

The unique cache key of the item to delete.

Returns

bool True if the item was successfully removed. False if there was an error.

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 24 of file Memory.php.

References $key.

    {
        unset($this->cache[$key]);

        return true;
    }

deleteMultiple()

PhpOffice\PhpSpreadsheet\Collection\Memory::deleteMultiple

(

$keys

)

Deletes multiple cache items in a single operation.

Parameters

iterable

$keys

A list of string-based keys to be deleted.

Returns

bool True if the items were successfully removed. False if there was an error.

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 31 of file Memory.php.

References $key, and $keys.

    {
        foreach ($keys as $key) {
            $this->delete($key);
        }

        return true;
    }

get()

PhpOffice\PhpSpreadsheet\Collection\Memory::get	(		$key,
			$default = null
	)

Fetches a value from the cache.

Parameters

string	$key	The unique key of this item in the cache.
mixed	$default	Default value to return if the key does not exist.

Returns

mixed The value of the item from the cache, or $default in case of cache miss.

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 40 of file Memory.php.

References $default, $key, and PhpOffice\PhpSpreadsheet\Collection\Memory\has().

    {
        if ($this->has($key)) {
            return $this->cache[$key];
        }

        return $default;
    }

Here is the call graph for this function:

getMultiple()

PhpOffice\PhpSpreadsheet\Collection\Memory::getMultiple	(		$keys,
			$default = null
	)

Obtains multiple cache items by their unique keys.

Parameters

iterable	$keys	A list of keys that can obtained in a single operation.
mixed	$default	Default value to return for keys that do not exist.

Returns

iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 49 of file Memory.php.

References $default, $key, $keys, and $results.

    {
        $results = [];
        foreach ($keys as $key) {
            $results[$key] = $this->get($key, $default);
        }

        return $results;
    }

has()

PhpOffice\PhpSpreadsheet\Collection\Memory::has

(

$key

)

Determines whether an item is present in the cache.

NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.

Parameters

string

$key

The cache item key.

Returns

bool

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 59 of file Memory.php.

References $key.

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

    {
        return array_key_exists($key, $this->cache);
    }

Here is the caller graph for this function:

set()

PhpOffice\PhpSpreadsheet\Collection\Memory::set	(		$key,
			$value,
			$ttl = null
	)

Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

Parameters

string	$key	The key of the item to store.
mixed	$value	The value of the item to store, must be serializable.
null | int | \DateInterval	$ttl	Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Returns

bool True on success and false on failure.

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 64 of file Memory.php.

References $key.

    {
        $this->cache[$key] = $value;

        return true;
    }

setMultiple()

PhpOffice\PhpSpreadsheet\Collection\Memory::setMultiple	(		$values,
			$ttl = null
	)

Persists a set of key => value pairs in the cache, with an optional TTL.

Parameters

iterable	$values	A list of key => value pairs for a multiple-set operation.
null | int | \DateInterval	$ttl	Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Returns

bool True on success and false on failure.

Exceptions

Implements Psr\SimpleCache\CacheInterface.

Definition at line 71 of file Memory.php.

References $key, and $values.

    {
        foreach ($values as $key => $value) {
            $this->set($key, $value);
        }

        return true;
    }

Field Documentation

$cache

PhpOffice\PhpSpreadsheet\Collection\Memory::$cache = []

private

Definition at line 15 of file Memory.php.

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Collection/Memory.php