RequestCloseSubscriber.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/EventSubscriber/RequestCloseSubscriber.php
  2. 8.9.x core/lib/Drupal/Core/EventSubscriber/RequestCloseSubscriber.php
  3. 10 core/lib/Drupal/Core/EventSubscriber/RequestCloseSubscriber.php

Namespace

Drupal\Core\EventSubscriber

File

core/lib/Drupal/Core/EventSubscriber/RequestCloseSubscriber.php

View source
<?php

namespace Drupal\Core\EventSubscriber;

use Drupal\Core\Extension\ModuleHandlerInterface;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\HttpKernel\Event\TerminateEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Subscriber for all responses.
 */
class RequestCloseSubscriber implements EventSubscriberInterface {
    
    /**
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * Constructs a new RequestCloseSubscriber instance.
     *
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     */
    public function __construct(ModuleHandlerInterface $module_handler) {
        $this->moduleHandler = $module_handler;
    }
    
    /**
     * Performs end of request tasks.
     *
     * @todo The body of this function has just been copied almost verbatim from
     *   drupal_page_footer(). There's probably a lot in here that needs to get
     *   removed/changed. Also, if possible, do more light-weight shutdowns on
     *   AJAX requests.
     *
     * @param \Symfony\Component\HttpKernel\Event\TerminateEvent $event
     *   The Event to process.
     */
    public function onTerminate(TerminateEvent $event) {
        $this->moduleHandler
            ->writeCache();
    }
    
    /**
     * Registers the methods in this class that should be listeners.
     *
     * @return array
     *   An array of event listener definitions.
     */
    public static function getSubscribedEvents() : array {
        $events[KernelEvents::TERMINATE][] = [
            'onTerminate',
            100,
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
RequestCloseSubscriber Subscriber for all responses.

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