KernelInterface

interface KernelInterface implements HttpKernelInterface, Serializable

The Kernel is the heart of the Symfony system.

It manages an environment made of bundles.

Methods

Response	handle(Request $request, int $type = self::MASTER_REQUEST, bool $catch = true) Handles a Request to convert it to a Response.	from HttpKernelInterface
BundleInterface[]	registerBundles() Returns an array of bundles to register.
	registerContainerConfiguration(LoaderInterface $loader) Loads the container configuration.
	boot() Boots the current kernel.
	shutdown() Shutdowns the kernel.
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.
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.

Details

Response handle(Request $request, int $type = self::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.

Parameters

Request	$request	A Request instance
int	$type	The type of the request (one of HttpKernelInterface::MASTERREQUEST or HttpKernelInterface::SUBREQUEST)
bool	$catch	Whether to catch exceptions or not

Return Value

Response

A Response instance

Exceptions

Exception

When an Exception occurs during processing

BundleInterface[] registerBundles()

Returns an array of bundles to register.

Return Value

BundleInterface[]

An array of bundle instances

registerContainerConfiguration(LoaderInterface $loader)

Loads the container configuration.

Parameters

LoaderInterface

$loader

A LoaderInterface instance

boot()

Boots the current kernel.

shutdown()

Shutdowns the kernel.

This method is mainly useful when doing functional testing.

BundleInterface[] getBundles()

Gets the registered bundle instances.

Return Value

BundleInterface[]

An array of registered bundle instances

BundleInterface|BundleInterface[] getBundle(string $name, bool $first = true)

Returns a bundle and optionally its descendants by its name.

Parameters

string	$name	Bundle name
bool	$first	Whether to return the first bundle only or together with its descendants

Return Value

BundleInterface|BundleInterface[]

A BundleInterface instance or an array of BundleInterface instances if $first is false

Exceptions

InvalidArgumentException

when the bundle is not enabled

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.

Parameters

string	$name	A resource name to locate
string	$dir	A directory where to look for the resource first
bool	$first	Whether to return the first path or paths for all matching bundles

Return Value

string|array

The absolute path of the resource or an array if $first is false

Exceptions

InvalidArgumentException	if the file cannot be found or the name is not valid
RuntimeException	if the name contains invalid/unsafe characters

string getName()

Gets the name of the kernel.

Return Value

string

The kernel name

string getEnvironment()

Gets the environment.

Return Value

string

The current environment

bool isDebug()

Checks if debug mode is enabled.

Return Value

bool	true if debug mode is enabled, false otherwise

string getRootDir()

Gets the application root dir.

Return Value

string

The application root dir

ContainerInterface getContainer()

Gets the current container.

Return Value

ContainerInterface

A ContainerInterface instance

int getStartTime()

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

Return Value

int	The request start timestamp

string getCacheDir()

Gets the cache directory.

Return Value

string

The cache directory

string getLogDir()

Gets the log directory.

Return Value

string

The log directory

string getCharset()

Gets the charset of the application.

Return Value

string

The charset

Links:

http://api.symfony.com/master/Symfony/Component/HttpKernel/KernelInterface.html

doc_Symfony

2016-10-28 06:22:10

Comments