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

PrivateTempStore deprecated

class PrivateTempStore extends PrivateTempStore (View source)

deprecated in drupal:8.5.0 and is removed from drupal:9.0.0. Use \Drupal\Core\TempStore\PrivateTempStore 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  PrivateTempStore
protected LockBackendInterface $lockBackend

The lock object used for this data.

 from  PrivateTempStore
protected AccountProxyInterface $currentUser

The current user.

 from  PrivateTempStore
protected RequestStack $requestStack

The request stack.

 from  PrivateTempStore
protected int $expire

The time to live for items in seconds.

 from  PrivateTempStore

Methods

__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

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

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

from  PrivateTempStore
mixed
get(string $key)

Retrieves a value from this PrivateTempStore for a given key.

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

Stores a particular key/value pair in this PrivateTempStore.

from  PrivateTempStore
Lock|null
getMetadata(string $key)

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

from  PrivateTempStore
bool
delete(string $key)

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

from  PrivateTempStore
string
createkey(string $key)

Ensures that the key is unique for a user.

from  PrivateTempStore
string
getOwner()

Gets the current owner based on the current user or the session ID.

from  PrivateTempStore
startSession()

Start session because it is required for a private temp store.

from  PrivateTempStore

Details

in DependencySerializationTrait at line 30
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 65
__wakeup()

{@inheritdoc}

in PrivateTempStore at line 86
__construct(KeyValueStoreExpirableInterface $storage, LockBackendInterface $lock_backend, AccountProxyInterface $current_user, 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.
AccountProxyInterface $current_user

The current user account.
RequestStack $request_stack

The request stack.
int $expire

The time to live for items, in seconds.

in PrivateTempStore at line 103
mixed get(string $key)

Retrieves a value from this PrivateTempStore 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 PrivateTempStore at line 121
set(string $key, mixed $value)

Stores a particular key/value pair in this PrivateTempStore.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.

Exceptions

TempStoreException

in PrivateTempStore at line 162
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 PrivateTempStore at line 186
bool 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.

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

in PrivateTempStore at line 214
protected string createkey(string $key)

Ensures that the key is unique for a user.

Parameters

string $key

The key.

Return Value

string

The unique key for the user.

in PrivateTempStore at line 224
protected string getOwner()

Gets the current owner based on the current user or the session ID.

Return Value

string

The owner.

in PrivateTempStore at line 243
protected startSession()

Start session because it is required for a private temp store.

Ensures that an anonymous user has a session created for them, as otherwise subsequent page loads will not be able to retrieve their tempstore data.

when https://www.drupal.org/node/2865991 is resolved, use force start session API.