interface DrupalKernelInterface in Zircon Profile 8.0

The interface for DrupalKernel, the core of Drupal.

This interface extends Symfony's KernelInterface and adds methods for responding to modules being enabled or disabled during its lifetime.

Hierarchy

• interface \Symfony\Component\HttpKernel\HttpKernelInterface; interface \Symfony\Component\DependencyInjection\ContainerAwareInterface
  • interface \Drupal\Core\DrupalKernelInterface

4 files declare their use of DrupalKernelInterface

KernelPreHandle.php in core/lib/Drupal/Core/StackMiddleware/KernelPreHandle.php

Contains \Drupal\Core\StackMiddleware\KernelPreHandle.

ModifyServiceDefinitionsPass.php in core/lib/Drupal/Core/DependencyInjection/Compiler/ModifyServiceDefinitionsPass.php

Contains \Drupal\Core\DependencyInjection\Compiler\ModifyServiceDefinitionsPass.

ModuleInstaller.php in core/lib/Drupal/Core/Extension/ModuleInstaller.php

Contains \Drupal\Core\Extension\ModuleInstaller.

UpdateRootFactory.php in core/modules/update/src/UpdateRootFactory.php

Contains \Drupal\update\UpdateRootFactory.

File

core/lib/Drupal/Core/DrupalKernelInterface.php, line 20

Contains \Drupal\Core\DrupalKernelInterface.

Namespace

Drupal\Core

interface DrupalKernelInterface extends HttpKernelInterface, ContainerAwareInterface {

  /**
   * Boots the current kernel.
   *
   * @return $this
   */
  public function boot();

  /**
   * Shuts down the kernel.
   */
  public function shutdown();

  /**
   * Discovers available serviceProviders.
   *
   * @return array
   *   The available serviceProviders.
   */
  public function discoverServiceProviders();

  /**
   * Returns all registered service providers.
   *
   * @param string $origin
   *   The origin for which to return service providers; one of 'app' or 'site'.
   *
   * @return array
   *   An associative array of ServiceProvider objects, keyed by name.
   */
  public function getServiceProviders($origin);

  /**
   * Gets the current container.
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
   *   A ContainerInterface instance.
   */
  public function getContainer();

  /**
   * Returns the cached container definition - if any.
   *
   * This also allows inspecting a built container for debugging purposes.
   *
   * @return array|NULL
   *   The cached container definition or NULL if not found in cache.
   */
  public function getCachedContainerDefinition();

  /**
   * Set the current site path.
   *
   * @param string $path
   *   The current site path.
   *
   * @throws \LogicException
   *   In case the kernel is already booted.
   */
  public function setSitePath($path);

  /**
   * Get the site path.
   *
   * @return string
   *   The current site path.
   */
  public function getSitePath();

  /**
   * Gets the app root.
   *
   * @return string
   */
  public function getAppRoot();

  /**
   * Updates the kernel's list of modules to the new list.
   *
   * The kernel needs to update its bundle list and container to match the new
   * list.
   *
   * @param array $module_list
   *   The new list of modules.
   * @param array $module_filenames
   *   List of module filenames, keyed by module name.
   */
  public function updateModules(array $module_list, array $module_filenames = array());

  /**
   * Force a container rebuild.
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
   */
  public function rebuildContainer();

  /**
   * Invalidate the service container for the next request.
   */
  public function invalidateContainer();

  /**
   * Prepare the kernel for handling a request without handling the request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return $this
   *
   * @deprecated 8.x
   *   Only used by legacy front-controller scripts.
   */
  public function prepareLegacyRequest(Request $request);

  /**
   * Helper method that does request related initialization.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   */
  public function preHandle(Request $request);

  /**
   * Helper method that loads legacy Drupal include files.
   */
  public function loadLegacyIncludes();

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerAwareInterface::setContainer	public	function	Sets the Container.	4
DrupalKernelInterface::boot	public	function	Boots the current kernel.	1
DrupalKernelInterface::discoverServiceProviders	public	function	Discovers available serviceProviders.	1
DrupalKernelInterface::getAppRoot	public	function	Gets the app root.	1
DrupalKernelInterface::getCachedContainerDefinition	public	function	Returns the cached container definition - if any.	1
DrupalKernelInterface::getContainer	public	function	Gets the current container.	1
DrupalKernelInterface::getServiceProviders	public	function	Returns all registered service providers.	1
DrupalKernelInterface::getSitePath	public	function	Get the site path.	1
DrupalKernelInterface::invalidateContainer	public	function	Invalidate the service container for the next request.	1
DrupalKernelInterface::loadLegacyIncludes	public	function	Helper method that loads legacy Drupal include files.	1
DrupalKernelInterface::preHandle	public	function	Helper method that does request related initialization.	1
DrupalKernelInterface::prepareLegacyRequest Deprecated	public	function	Prepare the kernel for handling a request without handling the request.	1
DrupalKernelInterface::rebuildContainer	public	function	Force a container rebuild.	1
DrupalKernelInterface::setSitePath	public	function	Set the current site path.	1
DrupalKernelInterface::shutdown	public	function	Shuts down the kernel.	1
DrupalKernelInterface::updateModules	public	function	Updates the kernel's list of modules to the new list.	1
HttpKernelInterface::handle	public	function	Handles a Request to convert it to a Response.	20
HttpKernelInterface::MASTER_REQUEST		constant
HttpKernelInterface::SUB_REQUEST		constant