FileAccess Orion

Kernel
in package

Application

implements KernelInterface, RebootableInterface, TerminableInterface

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.

Interfaces, Classes, Traits and Enums

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.

END_OF_LIFE = '11/2023'
END_OF_MAINTENANCE = '11/2022'
EXTRA_VERSION = ''
MAJOR_VERSION = 4
MINOR_VERSION = 4
RELEASE_VERSION = 8
VERSION = '4.4.8'
VERSION_ID = 40408
$booted : mixed
$bundles : array<string|int, BundleInterface>
$container : mixed
$debug : mixed
$environment : mixed
$name : mixed
$rootDir : mixed
$startTime : mixed
$freshCache : mixed
$projectDir : mixed
$requestStackSize : mixed
$resetServices : mixed
$warmupDir : mixed
__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.
getBundle() : BundleInterface: Returns a bundle.
getBundles() : array<string|int, 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.
getName() : string: Gets the name of the kernel.
getProjectDir() : string: Gets the application root dir (path of the project's composer file).
getRootDir() : string: Gets the application root dir (path of the project's Kernel class).
getStartTime() : float: Gets the request start time (not available if debug is disabled).
handle() : mixed: {@inheritdoc}
isDebug() : bool: Checks if debug mode is enabled.
locateResource() : string|array<string|int, mixed>: Returns the file path for a given bundle resource.
reboot() : mixed: Reboots a kernel.
serialize() : mixed
shutdown() : mixed: Shutdowns the kernel.
stripComments() : string: Removes comments from a PHP source string.
terminate() : mixed: Terminates a request/response cycle.
unserialize() : mixed
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 a 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.

END_OF_LIFE


    public
        mixed
    END_OF_LIFE
    = '11/2023'

END_OF_MAINTENANCE


    public
        mixed
    END_OF_MAINTENANCE
    = '11/2022'

EXTRA_VERSION


    public
        mixed
    EXTRA_VERSION
    = ''

MAJOR_VERSION


    public
        mixed
    MAJOR_VERSION
    = 4

MINOR_VERSION


    public
        mixed
    MINOR_VERSION
    = 4

RELEASE_VERSION


    public
        mixed
    RELEASE_VERSION
    = 8

VERSION


    public
        mixed
    VERSION
    = '4.4.8'

VERSION_ID


    public
        mixed
    VERSION_ID
    = 40408

$booted


    protected
        mixed
    $booted
     = false

$bundles


    protected
        array<string|int, BundleInterface>
    $bundles
     = []

$container


    protected
        mixed
    $container

$debug


    protected
        mixed
    $debug

$environment


    protected
        mixed
    $environment

$name


    protected
        mixed
    $name

$rootDir


    protected
        mixed
    $rootDir

$startTime


    protected
        mixed
    $startTime

$freshCache


    private
    static    mixed
    $freshCache
     = []

$projectDir


    private
        mixed
    $projectDir

$requestStackSize


    private
        mixed
    $requestStackSize
     = 0

$resetServices


    private
        mixed
    $resetServices
     = false

$warmupDir


    private
        mixed
    $warmupDir

__clone()


    public
                    __clone() : mixed

Return values

mixed —

__construct()


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

Parameters

$environment : string
$debug : bool

Return values

mixed —

__sleep()


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

Return values

array<string|int, mixed> —

__wakeup()


    public
                    __wakeup() : mixed

Return values

mixed —

boot()

Boots the current kernel.


    public
                    boot() : mixed

Return values

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> —

getBundle()

Returns a bundle.


    public
                    getBundle(mixed $name) : BundleInterface

Parameters

$name : mixed: Bundle name

Return values

BundleInterface —

A BundleInterface instance

getBundles()

Gets the registered bundle instances.


    public
                    getBundles() : array<string|int, BundleInterface>

Return values

array<string|int, BundleInterface> —

An array of registered bundle instances

getCacheDir()

Gets the cache directory.


    public
                    getCacheDir() : string

Return values

string —

The cache directory

getCharset()

Gets the charset of the application.


    public
                    getCharset() : string

Return values

string —

The charset

getContainer()

Gets the current container.


    public
                    getContainer() : ContainerInterface

Return values

ContainerInterface —

getEnvironment()

Gets the environment.


    public
                    getEnvironment() : string

Return values

string —

The current environment

getLogDir()

Gets the log directory.


    public
                    getLogDir() : string

Return values

string —

The log directory

getName()

Gets the name of the kernel.


    public
                    getName() : string

Return values

string —

The kernel name

getProjectDir()

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


    public
                    getProjectDir() : string

Return values

string —

The project root dir

getRootDir()

Gets the application root dir (path of the project's Kernel class).


    public
                    getRootDir() : string

Return values

string —

The Kernel root dir

getStartTime()

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


    public
                    getStartTime() : float

Return values

float —

The request start timestamp

handle()

{@inheritdoc}


    public
                    handle(Request $request[, mixed $type = HttpKernelInterface::MASTER_REQUEST ][, mixed $catch = true ]) : mixed

Parameters

$request : Request
$type : mixed = HttpKernelInterface::MASTER_REQUEST
$catch : mixed = true

Return values

mixed —

isDebug()

Checks if debug mode is enabled.


    public
                    isDebug() : bool

Return values

bool —

true if debug mode is enabled, false otherwise

locateResource()

Returns the file path for a given bundle resource.


    public
                    locateResource(mixed $name) : string|array<string|int, mixed>

Parameters

$name : mixed: A resource name to locate

Return values

string|array<string|int, mixed> —

The absolute path of the resource or an array if $first is false (array return value is deprecated)

reboot()

Reboots a kernel.


    public
                    reboot(mixed $warmupDir) : mixed

Parameters

$warmupDir : mixed: pass null to reboot in the regular cache directory

Return values

mixed —

serialize()


    public
                    serialize() : mixed

Return values

mixed —

shutdown()

Shutdowns the kernel.


    public
                    shutdown() : mixed

Return values

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: A PHP string

Return values

string —

The PHP string with the comments removed

terminate()

Terminates a request/response cycle.


    public
                    terminate(Request $request, Response $response) : mixed

Parameters

$request : Request
$response : Response

Return values

mixed —

unserialize()


    public
                    unserialize(mixed $data) : mixed

Parameters

$data : mixed

Return values

mixed —

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

Return values

mixed —

buildContainer()

Builds the service container.


    protected
                    buildContainer() : ContainerBuilder

Return values

ContainerBuilder —

The compiled service container

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

Return values

mixed —

getContainerBaseClass()

Gets the container's base class.


    protected
                    getContainerBaseClass() : string

All names except Container must be fully qualified.

Return values

string —

getContainerBuilder()

Gets a new ContainerBuilder instance used to build the service container.


    protected
                    getContainerBuilder() : ContainerBuilder

Return values

ContainerBuilder —

getContainerClass()

Gets the container class.


    protected
                    getContainerClass() : string

Return values

string —

The container class

getContainerLoader()

Returns a loader for the container.


    protected
                    getContainerLoader(ContainerInterface $container) : DelegatingLoader

Parameters

$container : ContainerInterface

Return values

DelegatingLoader —

The loader

getHttpKernel()

Gets a HTTP kernel from the container.


    protected
                    getHttpKernel() : HttpKernelInterface

Return values

HttpKernelInterface —

getKernelParameters()

Returns the kernel parameters.


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

Return values

array<string|int, mixed> —

An array of kernel parameters

initializeBundles()

Initializes bundles.


    protected
                    initializeBundles() : mixed

Return values

mixed —

initializeContainer()

Initializes the service container.


    protected
                    initializeContainer() : mixed

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

Return values

mixed —

prepareContainer()

Prepares the ContainerBuilder before it is compiled.


    protected
                    prepareContainer(ContainerBuilder $container) : mixed

Parameters

$container : ContainerBuilder

Return values

mixed —

Kernel in package Application implements KernelInterface, RebootableInterface, TerminableInterface

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

END_OF_LIFE

END_OF_MAINTENANCE

EXTRA_VERSION

MAJOR_VERSION

MINOR_VERSION

RELEASE_VERSION

VERSION

VERSION_ID

Properties

$booted

$bundles

$container

$debug

$environment

$name

Tags

$rootDir

Tags

$startTime

$freshCache

$projectDir

$requestStackSize

$resetServices

$warmupDir

Methods

__clone()

Return values

__construct()

Parameters

Return values

__sleep()

Return values

__wakeup()

Return values

boot()

Return values

getAnnotatedClassesToCompile()

Return values

getBundle()

Parameters

Return values

getBundles()

Return values

getCacheDir()

Return values

getCharset()

Return values

getContainer()

Return values

getEnvironment()

Return values

getLogDir()

Return values

getName()

Tags

Return values

getProjectDir()

Return values

getRootDir()

Tags

Return values

getStartTime()

Return values

handle()

Parameters

Return values

isDebug()

Return values

locateResource()

Parameters

Return values

reboot()

Parameters

Return values

serialize()

Kernel
in package

Application

implements KernelInterface, RebootableInterface, TerminableInterface