interface KernelInterface
The Kernel is the heart of the Symfony system.
It manages an environment made of application kernel and bundles.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- interface \Symfony\Component\HttpKernel\HttpKernelInterface
- interface \Symfony\Component\HttpKernel\KernelInterface extends \Symfony\Component\HttpKernel\HttpKernelInterface
Expanded class hierarchy of KernelInterface
All classes that implement KernelInterface
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\HttpKernelView source
interface KernelInterface extends HttpKernelInterface {
/**
* Returns an array of bundles to register.
*
* @return iterable<mixed, BundleInterface>
*/
public function registerBundles() : iterable;
/**
* Loads the container configuration.
*
* @return void
*/
public function registerContainerConfiguration(LoaderInterface $loader);
/**
* Boots the current kernel.
*
* @return void
*/
public function boot();
/**
* Shutdowns the kernel.
*
* This method is mainly useful when doing functional testing.
*
* @return void
*/
public function shutdown();
/**
* Gets the registered bundle instances.
*
* @return array<string, BundleInterface>
*/
public function getBundles() : array;
/**
* Returns a bundle.
*
* @throws \InvalidArgumentException when the bundle is not enabled
*/
public function getBundle(string $name) : BundleInterface;
/**
* Returns the file path for a given bundle 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.
*
* @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(string $name) : string;
/**
* Gets the environment.
*/
public function getEnvironment() : string;
/**
* Checks if debug mode is enabled.
*/
public function isDebug() : bool;
/**
* Gets the project dir (path of the project's composer file).
*/
public function getProjectDir() : string;
/**
* Gets the current container.
*/
public function getContainer() : ContainerInterface;
/**
* Gets the request start time (not available if debug is disabled).
*/
public function getStartTime() : float;
/**
* Gets the cache directory.
*
* Since Symfony 5.2, the cache directory should be used for caches that are written at runtime.
* For caches and artifacts that can be warmed at compile-time and deployed as read-only,
* use the new "build directory" returned by the {@see getBuildDir()} method.
*/
public function getCacheDir() : string;
/**
* Returns the build directory.
*
* This directory should be used to store build artifacts, and can be read-only at runtime.
* Caches written at runtime should be stored in the "cache directory" ({@see KernelInterface::getCacheDir()}).
*/
public function getBuildDir() : string;
/**
* Gets the log directory.
*/
public function getLogDir() : string;
/**
* Gets the charset of the application.
*/
public function getCharset() : string;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
HttpKernelInterface::handle | public | function | Handles a Request to convert it to a Response. | 17 |
HttpKernelInterface::MAIN_REQUEST | public | constant | ||
HttpKernelInterface::SUB_REQUEST | public | constant | ||
KernelInterface::boot | public | function | Boots the current kernel. | 1 |
KernelInterface::getBuildDir | public | function | Returns the build directory. | 1 |
KernelInterface::getBundle | public | function | Returns a bundle. | 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::getProjectDir | public | function | Gets the project dir (path of the project's composer file). | 1 |
KernelInterface::getStartTime | public | function | Gets the request start time (not available if debug is disabled). | 1 |
KernelInterface::isDebug | public | function | Checks if debug mode is enabled. | 1 |
KernelInterface::locateResource | public | function | Returns the file path for a given bundle resource. | 1 |
KernelInterface::registerBundles | public | function | Returns an array of bundles to register. | |
KernelInterface::registerContainerConfiguration | public | function | Loads the container configuration. | |
KernelInterface::shutdown | public | function | Shutdowns the kernel. | 1 |