SurrogateListener.php in Zircon Profile 8

Namespace

Symfony\Component\HttpKernel\EventListener

File

vendor/symfony/http-kernel/EventListener/SurrogateListener.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\HttpKernel\Event\FilterResponseEvent;
use Symfony\Component\HttpKernel\HttpCache\SurrogateInterface;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * SurrogateListener adds a Surrogate-Control HTTP header when the Response needs to be parsed for Surrogates.
 *
 * @author Fabien Potencier <[e-mail]>
 */
class SurrogateListener implements EventSubscriberInterface {
  private $surrogate;

  /**
   * Constructor.
   *
   * @param SurrogateInterface $surrogate An SurrogateInterface instance
   */
  public function __construct(SurrogateInterface $surrogate = null) {
    $this->surrogate = $surrogate;
  }

  /**
   * Filters the Response.
   *
   * @param FilterResponseEvent $event A FilterResponseEvent instance
   */
  public function onKernelResponse(FilterResponseEvent $event) {
    if (!$event
      ->isMasterRequest() || null === $this->surrogate) {
      return;
    }
    $this->surrogate
      ->addSurrogateControl($event
      ->getResponse());
  }
  public static function getSubscribedEvents() {
    return array(
      KernelEvents::RESPONSE => 'onKernelResponse',
    );
  }

}

Classes

Name	Description
SurrogateListener	SurrogateListener adds a Surrogate-Control HTTP header when the Response needs to be parsed for Surrogates.