interface KernelInterface in Zircon Profile 8.0

The Kernel is the heart of the Symfony system.

It manages an environment made of bundles.

@author Fabien Potencier <[e-mail]>

Hierarchy

• interface \Symfony\Component\HttpKernel\HttpKernelInterface
  • interface \Symfony\Component\HttpKernel\KernelInterface extends \Symfony\Component\HttpKernel\Serializable

3 files declare their use of KernelInterface

ConfigDataCollector.php in vendor/symfony/http-kernel/DataCollector/ConfigDataCollector.php

FileLocator.php in vendor/symfony/http-kernel/Config/FileLocator.php

TimeDataCollector.php in vendor/symfony/http-kernel/DataCollector/TimeDataCollector.php

File

vendor/symfony/http-kernel/KernelInterface.php, line 25

Namespace

Symfony\Component\HttpKernel

interface KernelInterface extends HttpKernelInterface, \Serializable {

  /**
   * Returns an array of bundles to register.
   *
   * @return BundleInterface[] An array of bundle instances.
   */
  public function registerBundles();

  /**
   * Loads the container configuration.
   *
   * @param LoaderInterface $loader A LoaderInterface instance
   */
  public function registerContainerConfiguration(LoaderInterface $loader);

  /**
   * Boots the current kernel.
   */
  public function boot();

  /**
   * Shutdowns the kernel.
   *
   * This method is mainly useful when doing functional testing.
   */
  public function shutdown();

  /**
   * Gets the registered bundle instances.
   *
   * @return BundleInterface[] An array of registered bundle instances
   */
  public function getBundles();

  /**
   * Checks if a given class name belongs to an active bundle.
   *
   * @param string $class A class name
   *
   * @return bool true if the class belongs to an active bundle, false otherwise
   *
   * @deprecated since version 2.6, to be removed in 3.0.
   */
  public function isClassInActiveBundle($class);

  /**
   * Returns a bundle and optionally its descendants by its name.
   *
   * @param string $name  Bundle name
   * @param bool   $first Whether to return the first bundle only or together with its descendants
   *
   * @return BundleInterface|BundleInterface[] A BundleInterface instance or an array of BundleInterface instances if $first is false
   *
   * @throws \InvalidArgumentException when the bundle is not enabled
   */
  public function getBundle($name, $first = true);

  /**
   * Returns the file path for a given resource.
   *
   * A Resource can be a file or a directory.
   *
   * The resource name must follow the following pattern:
   *
   *     "@BundleName/path/to/a/file.something"
   *
   * where BundleName is the name of the bundle
   * and the remaining part is the relative path in the bundle.
   *
   * If $dir is passed, and the first segment of the path is "Resources",
   * this method will look for a file named:
   *
   *     $dir/<BundleName>/path/without/Resources
   *
   * before looking in the bundle resource folder.
   *
   * @param string $name  A resource name to locate
   * @param string $dir   A directory where to look for the resource first
   * @param bool   $first Whether to return the first path or paths for all matching bundles
   *
   * @return string|array The absolute path of the resource or an array if $first is false
   *
   * @throws \InvalidArgumentException if the file cannot be found or the name is not valid
   * @throws \RuntimeException         if the name contains invalid/unsafe characters
   */
  public function locateResource($name, $dir = null, $first = true);

  /**
   * Gets the name of the kernel.
   *
   * @return string The kernel name
   */
  public function getName();

  /**
   * Gets the environment.
   *
   * @return string The current environment
   */
  public function getEnvironment();

  /**
   * Checks if debug mode is enabled.
   *
   * @return bool true if debug mode is enabled, false otherwise
   */
  public function isDebug();

  /**
   * Gets the application root dir.
   *
   * @return string The application root dir
   */
  public function getRootDir();

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

  /**
   * Gets the request start time (not available if debug is disabled).
   *
   * @return int The request start timestamp
   */
  public function getStartTime();

  /**
   * Gets the cache directory.
   *
   * @return string The cache directory
   */
  public function getCacheDir();

  /**
   * Gets the log directory.
   *
   * @return string The log directory
   */
  public function getLogDir();

  /**
   * Gets the charset of the application.
   *
   * @return string The charset
   */
  public function getCharset();

}

Members

Name	Modifiers	Type	Description	Overrides
HttpKernelInterface::handle	public	function	Handles a Request to convert it to a Response.	20
HttpKernelInterface::MASTER_REQUEST		constant
HttpKernelInterface::SUB_REQUEST		constant
KernelInterface::boot	public	function	Boots the current kernel.	1
KernelInterface::getBundle	public	function	Returns a bundle and optionally its descendants by its name.	1
KernelInterface::getBundles	public	function	Gets the registered bundle instances.	1
KernelInterface::getCacheDir	public	function	Gets the cache directory.	1
KernelInterface::getCharset	public	function	Gets the charset of the application.	1
KernelInterface::getContainer	public	function	Gets the current container.	1
KernelInterface::getEnvironment	public	function	Gets the environment.	1
KernelInterface::getLogDir	public	function	Gets the log directory.	1
KernelInterface::getName	public	function	Gets the name of the kernel.	1
KernelInterface::getRootDir	public	function	Gets the application root dir.	1
KernelInterface::getStartTime	public	function	Gets the request start time (not available if debug is disabled).	1
KernelInterface::isClassInActiveBundle Deprecated	public	function	Checks if a given class name belongs to an active bundle.	1
KernelInterface::isDebug	public	function	Checks if debug mode is enabled.	1
KernelInterface::locateResource	public	function	Returns the file path for a given resource.	1
KernelInterface::registerBundles	public	function	Returns an array of bundles to register.	3
KernelInterface::registerContainerConfiguration	public	function	Loads the container configuration.	3
KernelInterface::shutdown	public	function	Shutdowns the kernel.	1