class SharedTempStoreFactory

Same name in this branch
  1. 8.9.x core/modules/user/src/SharedTempStoreFactory.php \Drupal\user\SharedTempStoreFactory
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php \Drupal\Core\TempStore\SharedTempStoreFactory
  2. 10 core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php \Drupal\Core\TempStore\SharedTempStoreFactory
  3. 11.x core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php \Drupal\Core\TempStore\SharedTempStoreFactory

Creates a shared temporary storage for a collection.

Hierarchy

Expanded class hierarchy of SharedTempStoreFactory

8 files declare their use of SharedTempStoreFactory
BreakLockForm.php in core/modules/views_ui/src/Form/BreakLockForm.php
LayoutBuilderSampleEntityGenerator.php in core/modules/layout_builder/src/Entity/LayoutBuilderSampleEntityGenerator.php
LayoutTempstoreRepository.php in core/modules/layout_builder/src/LayoutTempstoreRepository.php
LayoutTempstoreRepositoryTest.php in core/modules/layout_builder/tests/src/Unit/LayoutTempstoreRepositoryTest.php
SharedTempStoreFactory.php in core/modules/user/src/SharedTempStoreFactory.php

... See full list

1 string reference to 'SharedTempStoreFactory'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses SharedTempStoreFactory
tempstore.shared in core/core.services.yml
Drupal\Core\TempStore\SharedTempStoreFactory

File

core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php, line 12

Namespace

Drupal\Core\TempStore
View source
class SharedTempStoreFactory {
    
    /**
     * The storage factory creating the backend to store the data.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface
     */
    protected $storageFactory;
    
    /**
     * The lock object used for this data.
     *
     * @var \Drupal\Core\Lock\LockBackendInterface
     */
    protected $lockBackend;
    
    /**
     * The request stack.
     *
     * @var \Symfony\Component\HttpFoundation\RequestStack
     */
    protected $requestStack;
    
    /**
     * The time to live for items in seconds.
     *
     * @var int
     */
    protected $expire;
    
    /**
     * Constructs a Drupal\Core\TempStore\SharedTempStoreFactory object.
     *
     * @param \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface $storage_factory
     *   The key/value store factory.
     * @param \Drupal\Core\Lock\LockBackendInterface $lock_backend
     *   The lock object used for this data.
     * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
     *   The request stack.
     * @param int $expire
     *   The time to live for items, in seconds.
     */
    public function __construct(KeyValueExpirableFactoryInterface $storage_factory, LockBackendInterface $lock_backend, RequestStack $request_stack, $expire = 604800) {
        $this->storageFactory = $storage_factory;
        $this->lockBackend = $lock_backend;
        $this->requestStack = $request_stack;
        $this->expire = $expire;
    }
    
    /**
     * Creates a SharedTempStore for the current user or anonymous session.
     *
     * @param string $collection
     *   The collection name to use for this key/value store. This is typically
     *   a shared namespace or module name, e.g. 'views', 'entity', etc.
     * @param mixed $owner
     *   (optional) The owner of this SharedTempStore. By default, the
     *   SharedTempStore is owned by the currently authenticated user, or by the
     *   active anonymous session if no user is logged in.
     *
     * @return \Drupal\Core\TempStore\SharedTempStore
     *   An instance of the key/value store.
     */
    public function get($collection, $owner = NULL) {
        // Use the currently authenticated user ID or the active user ID unless
        // the owner is overridden.
        if (!isset($owner)) {
            $owner = \Drupal::currentUser()->id() ?: session_id();
        }
        // Store the data for this collection in the database.
        $storage = $this->storageFactory
            ->get("tempstore.shared.{$collection}");
        return new SharedTempStore($storage, $this->lockBackend, $owner, $this->requestStack, $this->expire);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
SharedTempStoreFactory::$expire protected property The time to live for items in seconds.
SharedTempStoreFactory::$lockBackend protected property The lock object used for this data.
SharedTempStoreFactory::$requestStack protected property The request stack.
SharedTempStoreFactory::$storageFactory protected property The storage factory creating the backend to store the data.
SharedTempStoreFactory::get public function Creates a SharedTempStore for the current user or anonymous session. 1
SharedTempStoreFactory::__construct public function Constructs a Drupal\Core\TempStore\SharedTempStoreFactory object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.