TestSessionListener.php in Zircon Profile 8.0

Namespace

Symfony\Component\HttpKernel\EventListener

File

vendor/symfony/http-kernel/EventListener/TestSessionListener.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpKernel\EventListener;

use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * TestSessionListener.
 *
 * Saves session in test environment.
 *
 * @author Bulat Shakirzyanov <[e-mail]>
 * @author Fabien Potencier <[e-mail]>
 */
abstract class TestSessionListener implements EventSubscriberInterface {
  public function onKernelRequest(GetResponseEvent $event) {
    if (!$event
      ->isMasterRequest()) {
      return;
    }

    // bootstrap the session
    $session = $this
      ->getSession();
    if (!$session) {
      return;
    }
    $cookies = $event
      ->getRequest()->cookies;
    if ($cookies
      ->has($session
      ->getName())) {
      $session
        ->setId($cookies
        ->get($session
        ->getName()));
    }
  }

  /**
   * Checks if session was initialized and saves if current request is master
   * Runs on 'kernel.response' in test environment.
   *
   * @param FilterResponseEvent $event
   */
  public function onKernelResponse(FilterResponseEvent $event) {
    if (!$event
      ->isMasterRequest()) {
      return;
    }
    $session = $event
      ->getRequest()
      ->getSession();
    if ($session && $session
      ->isStarted()) {
      $session
        ->save();
      $params = session_get_cookie_params();
      $event
        ->getResponse()->headers
        ->setCookie(new Cookie($session
        ->getName(), $session
        ->getId(), 0 === $params['lifetime'] ? 0 : time() + $params['lifetime'], $params['path'], $params['domain'], $params['secure'], $params['httponly']));
    }
  }
  public static function getSubscribedEvents() {
    return array(
      KernelEvents::REQUEST => array(
        'onKernelRequest',
        192,
      ),
      KernelEvents::RESPONSE => array(
        'onKernelResponse',
        -128,
      ),
    );
  }

  /**
   * Gets the session object.
   *
   * @return SessionInterface|null A SessionInterface instance or null if no session is available
   */
  protected abstract function getSession();

}

Classes

Name	Description
TestSessionListener	TestSessionListener.