Documentation

Kernel
in package
implements KernelInterface, RebootableInterface, TerminableInterface

AbstractYes

The Kernel is the heart of the Symfony system.

It manages an environment made of bundles.

Environment names must always start with a letter and they must only contain letters and numbers.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

Interfaces

KernelInterface
The Kernel is the heart of the Symfony system.
RebootableInterface
Allows the Kernel to be rebooted using a temporary cache directory.
TerminableInterface
Terminable extends the Kernel request/response cycle with dispatching a post response event after sending the response and before shutting down the kernel.

Constants

END_OF_LIFE  = '01/2023'
END_OF_MAINTENANCE  = '01/2023'
EXTRA_VERSION  = ''
MAJOR_VERSION  = 6
MINOR_VERSION  = 0
RELEASE_VERSION  = 20
VERSION  = '6.0.20'
VERSION_ID  = 60020

Properties

$booted  : mixed
$bundles  : array<string, BundleInterface>
$container  : mixed
$debug  : mixed
$environment  : mixed
$startTime  : mixed
$freshCache  : array<string, bool>
$projectDir  : string
$requestStackSize  : int
$resetServices  : bool
$warmupDir  : string|null

Methods

__clone()  : mixed
__construct()  : mixed
__sleep()  : array<string|int, mixed>
__wakeup()  : mixed
boot()  : mixed
Boots the current kernel.
getAnnotatedClassesToCompile()  : array<string|int, mixed>
Gets the patterns defining the classes to parse and cache for annotations.
getBuildDir()  : string
Returns the build directory.
getBundle()  : BundleInterface
Returns a bundle.
getBundles()  : array<string, BundleInterface>
Gets the registered bundle instances.
getCacheDir()  : string
Gets the cache directory.
getCharset()  : string
Gets the charset of the application.
getContainer()  : ContainerInterface
Gets the current container.
getEnvironment()  : string
Gets the environment.
getLogDir()  : string
Gets the log directory.
getProjectDir()  : string
Gets the application root dir (path of the project's composer file).
getStartTime()  : float
Gets the request start time (not available if debug is disabled).
handle()  : Response
{@inheritdoc}
isDebug()  : bool
Checks if debug mode is enabled.
locateResource()  : string
Returns the file path for a given bundle resource.
reboot()  : mixed
Reboots a kernel.
shutdown()  : mixed
Shutdowns the kernel.
stripComments()  : string
Removes comments from a PHP source string.
terminate()  : mixed
Terminates a request/response cycle.
build()  : mixed
The extension point similar to the Bundle::build() method.
buildContainer()  : ContainerBuilder
Builds the service container.
dumpContainer()  : mixed
Dumps the service container to PHP code in the cache.
getContainerBaseClass()  : string
Gets the container's base class.
getContainerBuilder()  : ContainerBuilder
Gets a new ContainerBuilder instance used to build the service container.
getContainerClass()  : string
Gets the container class.
getContainerLoader()  : DelegatingLoader
Returns a loader for the container.
getHttpKernel()  : HttpKernelInterface
Gets an HTTP kernel from the container.
getKernelParameters()  : array<string|int, mixed>
Returns the kernel parameters.
initializeBundles()  : mixed
Initializes bundles.
initializeContainer()  : mixed
Initializes the service container.
prepareContainer()  : mixed
Prepares the ContainerBuilder before it is compiled.
preBoot()  : ContainerInterface

Constants

END_OF_LIFE

public mixed END_OF_LIFE = '01/2023'

END_OF_MAINTENANCE

public mixed END_OF_MAINTENANCE = '01/2023'

EXTRA_VERSION

public mixed EXTRA_VERSION = ''

MAJOR_VERSION

public mixed MAJOR_VERSION = 6

MINOR_VERSION

public mixed MINOR_VERSION = 0

RELEASE_VERSION

public mixed RELEASE_VERSION = 20

VERSION

public mixed VERSION = '6.0.20'

VERSION_ID

public mixed VERSION_ID = 60020

Properties

$booted

protected mixed $booted = false

$container

protected mixed $container

$environment

protected mixed $environment

$startTime

protected mixed $startTime

$freshCache

private static array<string, bool> $freshCache = []

$projectDir

private string $projectDir

$requestStackSize

private int $requestStackSize = 0

$resetServices

private bool $resetServices = false

$warmupDir

private string|null $warmupDir = null

Methods

__clone()

public __clone() : mixed

__construct()

public __construct(string $environment, bool $debug) : mixed
Parameters
$environment : string
$debug : bool

__sleep()

public __sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>

__wakeup()

public __wakeup() : mixed

boot()

Boots the current kernel.

public boot() : mixed

getAnnotatedClassesToCompile()

Gets the patterns defining the classes to parse and cache for annotations.

public getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBuildDir()

Returns the build directory.

public getBuildDir() : string
Return values
string

getCacheDir()

Gets the cache directory.

public getCacheDir() : string
Return values
string

getCharset()

Gets the charset of the application.

public getCharset() : string
Return values
string

getEnvironment()

Gets the environment.

public getEnvironment() : string
Return values
string

getLogDir()

Gets the log directory.

public getLogDir() : string
Return values
string

getProjectDir()

Gets the application root dir (path of the project's composer file).

public getProjectDir() : string
Return values
string

getStartTime()

Gets the request start time (not available if debug is disabled).

public getStartTime() : float
Return values
float

handle()

{@inheritdoc}

public handle(Request $request[, int $type = HttpKernelInterface::MAIN_REQUEST ][, bool $catch = true ]) : Response
Parameters
$request : Request
$type : int = HttpKernelInterface::MAIN_REQUEST
$catch : bool = true
Return values
Response

isDebug()

Checks if debug mode is enabled.

public isDebug() : bool
Return values
bool

locateResource()

Returns the file path for a given bundle resource.

public locateResource(string $name) : string
Parameters
$name : string
Return values
string

reboot()

Reboots a kernel.

public reboot(string|null $warmupDir) : mixed
Parameters
$warmupDir : string|null

pass null to reboot in the regular build directory

shutdown()

Shutdowns the kernel.

public shutdown() : mixed

stripComments()

Removes comments from a PHP source string.

public static stripComments(string $source) : string

We don't use the PHP php_strip_whitespace() function as we want the content to be readable and well-formatted.

Parameters
$source : string
Return values
string

build()

The extension point similar to the Bundle::build() method.

protected build(ContainerBuilder $container) : mixed

Use this method to register compiler passes and manipulate the container during the building process.

Parameters
$container : ContainerBuilder

dumpContainer()

Dumps the service container to PHP code in the cache.

protected dumpContainer(ConfigCache $cache, ContainerBuilder $container, string $class, string $baseClass) : mixed
Parameters
$cache : ConfigCache
$container : ContainerBuilder
$class : string

The name of the class to generate

$baseClass : string

The name of the container's base class

getContainerBaseClass()

Gets the container's base class.

protected getContainerBaseClass() : string

All names except Container must be fully qualified.

Return values
string

getContainerClass()

Gets the container class.

protected getContainerClass() : string
Tags
throws
InvalidArgumentException

If the generated classname is invalid

Return values
string

getKernelParameters()

Returns the kernel parameters.

protected getKernelParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

initializeBundles()

Initializes bundles.

protected initializeBundles() : mixed
Tags
throws
LogicException

if two bundles share a common name

initializeContainer()

Initializes the service container.

protected initializeContainer() : mixed

The built version of the service container is used when fresh, otherwise the container is built.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results