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