class CleanerSessionClearEventSubscriber in Cleaner 8.2

Class CleanerSessionClearEventSubscriber.

@package Drupal\cleaner\EventSubscriber

Hierarchy

• class \Drupal\cleaner\EventSubscriber\CleanerSessionClearEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface, ContainerInjectionInterface

1 file declares its use of CleanerSessionClearEventSubscriber

CleanerKernelTests.php in tests/src/Kernel/CleanerKernelTests.php

1 string reference to 'CleanerSessionClearEventSubscriber'

cleaner.services.yml in ./cleaner.services.yml

cleaner.services.yml

1 service uses CleanerSessionClearEventSubscriber

cleaner.session_clear_subscriber in ./cleaner.services.yml

Drupal\cleaner\EventSubscriber\CleanerSessionClearEventSubscriber

File

src/EventSubscriber/CleanerSessionClearEventSubscriber.php, line 19

Namespace

Drupal\cleaner\EventSubscriber

class CleanerSessionClearEventSubscriber implements EventSubscriberInterface, ContainerInjectionInterface {

  /**
   * Database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Config object.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * Logger channel.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $loggerChannel;

  /**
   * Request timestamp.
   *
   * @var int
   */
  protected $requestTime;

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[CleanerRunEvent::CLEANER_RUN][] = [
      'clearSession',
      100,
    ];
    return $events;
  }

  /**
   * CleanerSessionClearEventSubscriber constructor.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   Database connection.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_channel_factory
   *   Logger channel factory.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   Date time service.
   */
  public function __construct(Connection $database, ConfigFactoryInterface $config_factory, LoggerChannelFactoryInterface $logger_channel_factory, TimeInterface $time) {
    $this->database = $database;
    $this->config = $config_factory
      ->get('cleaner.settings');
    $this->loggerChannel = $logger_channel_factory
      ->get('cleaner');
    $this->requestTime = $time
      ->getRequestTime();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'), $container
      ->get('config.factory'), $container
      ->get('logger.factory'), $container
      ->get('datetime.time'));
  }

  /**
   * Cleaner session clearing.
   */
  public function clearSession() {
    if ($this->config
      ->get('cleaner_clean_sessions')) {
      $count = $this->database
        ->delete('sessions')
        ->condition('timestamp', $this
        ->getExpirationTime(), '<')
        ->execute();
      if ($count) {
        $this->loggerChannel
          ->info('Old sessions cleared.');
      }
    }
  }

  /**
   * Get the sessions expiration time.
   *
   * @return int
   *   Expiration timestamp.
   */
  protected function getExpirationTime() {
    return (int) ($this->requestTime - session_get_cookie_params()['lifetime']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CleanerSessionClearEventSubscriber::$config	protected	property	Config object.
CleanerSessionClearEventSubscriber::$database	protected	property	Database connection.
CleanerSessionClearEventSubscriber::$loggerChannel	protected	property	Logger channel.
CleanerSessionClearEventSubscriber::$requestTime	protected	property	Request timestamp.
CleanerSessionClearEventSubscriber::clearSession	public	function	Cleaner session clearing.
CleanerSessionClearEventSubscriber::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
CleanerSessionClearEventSubscriber::getExpirationTime	protected	function	Get the sessions expiration time.
CleanerSessionClearEventSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
CleanerSessionClearEventSubscriber::__construct	public	function	CleanerSessionClearEventSubscriber constructor.