1. class
  2. Drupal
  3. \
  4. user
  5. \
  6. SharedTempStore

SharedTempStore deprecated

class SharedTempStore extends SharedTempStore (View source)

deprecated in drupal:8.5.0 and is removed from drupal:9.0.0. Use \Drupal\Core\TempStore\SharedTempStore instead.

Stores and retrieves temporary data for a given owner.

Traits

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

Properties

protected array $_serviceIds

An array of service IDs keyed by property name used for serialization.

 from  DependencySerializationTrait
protected array $_entityStorages

An array of entity type IDs keyed by the property name of their storages.

 from  DependencySerializationTrait
protected KeyValueStoreExpirableInterface $storage

The key/value storage object used for this data.

 from  SharedTempStore
protected LockBackendInterface $lockBackend

The lock object used for this data.

 from  SharedTempStore
protected RequestStack $requestStack

The request stack.

 from  SharedTempStore
protected mixed $owner

The owner key to store along with the data (e.g. a user or session ID).

 from  SharedTempStore
protected int $expire

The time to live for items in seconds.

 from  SharedTempStore

Methods

__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

from  DependencySerializationTrait
__construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, mixed $owner, RequestStack $request_stack, int $expire = 604800)

Constructs a new object for accessing data from a key/value store.

from  SharedTempStore
mixed
get(string $key)

Retrieves a value from this SharedTempStore for a given key.

from  SharedTempStore
mixed
getIfOwner(string $key)

Retrieves a value from this SharedTempStore for a given key.

from  SharedTempStore
bool
setIfNotExists(string $key, mixed $value)

Stores a particular key/value pair only if the key doesn't already exist.

from  SharedTempStore
bool
setIfOwner(string $key, mixed $value)

Stores a particular key/value pair in this SharedTempStore.

from  SharedTempStore
set(string $key, mixed $value)

Stores a particular key/value pair in this SharedTempStore.

from  SharedTempStore
Lock|null
getMetadata(string $key)

Returns the metadata associated with a particular key/value pair.

from  SharedTempStore
delete(string $key)

Deletes data from the store for a given key and releases the lock on it.

from  SharedTempStore
bool
deleteIfOwner(string $key)

Deletes data from the store for a given key and releases the lock on it.

from  SharedTempStore

Details

in DependencySerializationTrait at line 30
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 65
__wakeup()

{@inheritdoc}

in SharedTempStore at line 96
__construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, mixed $owner, RequestStack $request_stack, int $expire = 604800)

Constructs a new object for accessing data from a key/value store.

Parameters

KeyValueStoreExpirableInterface $storage

The key/value storage object used for this data. Each storage object represents a particular collection of data and will contain any number of key/value pairs.
LockBackendInterface $lock_backend

The lock object used for this data.
mixed $owner

The owner key to store along with the data (e.g. a user or session ID).
RequestStack $request_stack

The request stack.
int $expire

The time to live for items, in seconds.

in SharedTempStore at line 113
mixed get(string $key)

Retrieves a value from this SharedTempStore for a given key.

Parameters

string $key

The key of the data to retrieve.

Return Value

mixed

The data associated with the key, or NULL if the key does not exist.

in SharedTempStore at line 130
mixed getIfOwner(string $key)

Retrieves a value from this SharedTempStore for a given key.

Only returns the value if the value is owned by $this->owner.

Parameters

string $key

The key of the data to retrieve.

Return Value

mixed

The data associated with the key, or NULL if the key does not exist.

in SharedTempStore at line 147
bool setIfNotExists(string $key, mixed $value)

Stores a particular key/value pair only if the key doesn't already exist.

Parameters

string $key

The key of the data to check and store.
mixed $value

The data to store.

Return Value

bool

TRUE if the data was set, or FALSE if it already existed.

in SharedTempStore at line 174
bool setIfOwner(string $key, mixed $value)

Stores a particular key/value pair in this SharedTempStore.

Only stores the given key/value pair if it does not exist yet or is owned by $this->owner.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.

Return Value

bool

TRUE if the data was set, or FALSE if it already exists and is not owned by $this->user.

Exceptions

TempStoreException

in SharedTempStore at line 198
set(string $key, mixed $value)

Stores a particular key/value pair in this SharedTempStore.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.

Exceptions

TempStoreException

in SharedTempStore at line 225
Lock|null getMetadata(string $key)

Returns the metadata associated with a particular key/value pair.

Parameters

string $key

The key of the data to store.

Return Value

Lock|null

An object with the owner and updated time if the key has a value, or NULL otherwise.

in SharedTempStore at line 244
delete(string $key)

Deletes data from the store for a given key and releases the lock on it.

Parameters

string $key

The key of the data to delete.

Exceptions

TempStoreException

in SharedTempStore at line 270
bool deleteIfOwner(string $key)

Deletes data from the store for a given key and releases the lock on it.

Only delete the given key if it is owned by $this->owner.

Parameters

string $key

The key of the data to delete.

Return Value

bool

TRUE if the object was deleted or does not exist, FALSE if it exists but is not owned by $this->owner.

Exceptions

TempStoreException