Kernel (Component\HttpKernel)
Symfony\Component\HttpKernel\Kernel
abstract class Kernel implements KernelInterface, TerminableInterface
The Kernel is the heart of the Symfony system.
It manages an environment made of bundles.
Constants
VERSION | |
VERSION_ID | |
MAJOR_VERSION | |
MINOR_VERSION | |
RELEASE_VERSION | |
EXTRA_VERSION | |
END_OF_MAINTENANCE | |
END_OF_LIFE |
Methods
__construct(string $environment, bool $debug) Constructor. | ||
__clone() | ||
boot() Boots the current kernel. | ||
terminate(Request $request, Response $response) Terminates a request/response cycle. | ||
shutdown() Shutdowns the kernel. | ||
Response | handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true) Handles a Request to convert it to a Response. | |
BundleInterface[] | getBundles() Gets the registered bundle instances. | |
BundleInterface|BundleInterface[] | getBundle(string $name, bool $first = true) Returns a bundle and optionally its descendants by its name. | |
string|array | locateResource(string $name, string $dir = null, bool $first = true) Returns the file path for a given resource. | |
string | getName() Gets the name of the kernel. | |
string | getEnvironment() Gets the environment. | |
bool | isDebug() Checks if debug mode is enabled. | |
string | getRootDir() Gets the application root dir. | |
ContainerInterface | getContainer() Gets the current container. | |
loadClassCache(string $name = 'classes', string $extension = '.php') Loads the PHP class cache. | ||
setClassCache(array $classes) Used internally. | ||
int | getStartTime() Gets the request start time (not available if debug is disabled). | |
string | getCacheDir() Gets the cache directory. | |
string | getLogDir() Gets the log directory. | |
string | getCharset() Gets the charset of the application. | |
static string | stripComments(string $source) Removes comments from a PHP source string. | |
serialize() | ||
unserialize($data) |
Details
public __construct(string $environment, bool $debug)
Constructor.
public __clone()
public boot()
Boots the current kernel.
public terminate(Request $request, Response $response)
Terminates a request/response cycle.
Should be called after sending the response and before shutting down the kernel.
public shutdown()
Shutdowns the kernel.
This method is mainly useful when doing functional testing.
public Response handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true)
Handles a Request to convert it to a Response.
When $catch is true, the implementation must catch all exceptions and do its best to convert them to a Response instance.
public BundleInterface[] getBundles()
Gets the registered bundle instances.
public BundleInterface|BundleInterface[] getBundle(string $name, bool $first = true)
Returns a bundle and optionally its descendants by its name.
public string|array locateResource(string $name, string $dir = null, bool $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.
public string getName()
Gets the name of the kernel.
public string getEnvironment()
Gets the environment.
public bool isDebug()
Checks if debug mode is enabled.
public string getRootDir()
Gets the application root dir.
public ContainerInterface getContainer()
Gets the current container.
public loadClassCache(string $name = 'classes', string $extension = '.php')
Loads the PHP class cache.
This methods only registers the fact that you want to load the cache classes. The cache will actually only be loaded when the Kernel is booted.
That optimization is mainly useful when using the HttpCache class in which case the class cache is not loaded if the Response is in the cache.
public setClassCache(array $classes)
Used internally.
public int getStartTime()
Gets the request start time (not available if debug is disabled).
public string getCacheDir()
Gets the cache directory.
public string getLogDir()
Gets the log directory.
public string getCharset()
Gets the charset of the application.
static public string stripComments(string $source)
Removes comments from a PHP source string.
We don't use the PHP phpstripwhitespace() function as we want the content to be readable and well-formatted.
public serialize()
public unserialize($data)
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpKernel/Kernel.html