function SharedTempStoreFactory::__construct

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php \Drupal\Core\TempStore\SharedTempStoreFactory::__construct()
  2. 10 core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php \Drupal\Core\TempStore\SharedTempStoreFactory::__construct()
  3. 11.x core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php \Drupal\Core\TempStore\SharedTempStoreFactory::__construct()

Constructs a Drupal\Core\TempStore\SharedTempStoreFactory object.

Parameters

\Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface $storage_factory: The key/value store factory.

\Drupal\Core\Lock\LockBackendInterface $lock_backend: The lock object used for this data.

\Symfony\Component\HttpFoundation\RequestStack $request_stack: The request stack.

\Drupal\Core\Session\AccountProxyInterface $current_user: The current user.

int $expire: The time to live for items, in seconds.

File

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

Class

SharedTempStoreFactory
Creates a shared temporary storage for a collection.

Namespace

Drupal\Core\TempStore

Code

public function __construct(KeyValueExpirableFactoryInterface $storage_factory, LockBackendInterface $lock_backend, RequestStack $request_stack, $current_user = NULL, $expire = 604800) {
    $this->storageFactory = $storage_factory;
    $this->lockBackend = $lock_backend;
    $this->requestStack = $request_stack;
    if (!$current_user instanceof AccountProxyInterface) {
        @trigger_error('Calling ' . __METHOD__ . '() without the $current_user argument is deprecated in drupal:9.2.0 and will be required in drupal:10.0.0. See https://www.drupal.org/node/3006268', E_USER_DEPRECATED);
        if (is_int($current_user)) {
            // If the $current_user argument is numeric then this object has been
            // instantiated with the old constructor signature.
            $expire = $current_user;
        }
        $current_user = \Drupal::currentUser();
    }
    $this->currentUser = $current_user;
    $this->expire = $expire;
}

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