2011-01-25 16:07:37 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Symfony package.
|
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Symfony\Component\HttpKernel;
|
|
|
|
|
2018-07-26 10:03:18 +01:00
|
|
|
use Symfony\Component\Config\Loader\LoaderInterface;
|
2011-01-25 16:07:37 +00:00
|
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
|
|
use Symfony\Component\HttpKernel\Bundle\BundleInterface;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The Kernel is the heart of the Symfony system.
|
|
|
|
*
|
2018-03-09 14:05:02 +00:00
|
|
|
* It manages an environment made of application kernel and bundles.
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
2018-10-17 09:55:49 +01:00
|
|
|
*
|
|
|
|
* @method string getProjectDir() Gets the project dir (path of the project's composer file) - not defining it is deprecated since Symfony 4.2
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2019-02-17 14:15:12 +00:00
|
|
|
interface KernelInterface extends HttpKernelInterface
|
2011-01-25 16:07:37 +00:00
|
|
|
{
|
|
|
|
/**
|
2014-03-24 15:32:55 +00:00
|
|
|
* Returns an array of bundles to register.
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
2018-03-17 12:20:09 +00:00
|
|
|
* @return iterable|BundleInterface[] An iterable of bundle instances
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function registerBundles();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
2014-03-24 15:32:55 +00:00
|
|
|
* Loads the container configuration.
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function registerContainerConfiguration(LoaderInterface $loader);
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Boots the current kernel.
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function boot();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Shutdowns the kernel.
|
|
|
|
*
|
|
|
|
* This method is mainly useful when doing functional testing.
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function shutdown();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the registered bundle instances.
|
|
|
|
*
|
2012-11-01 15:08:59 +00:00
|
|
|
* @return BundleInterface[] An array of registered bundle instances
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getBundles();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
2017-09-11 19:36:05 +01:00
|
|
|
* Returns a bundle.
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
2017-09-11 19:36:05 +01:00
|
|
|
* @param string $name Bundle name
|
2017-09-11 18:56:43 +01:00
|
|
|
*
|
2017-09-11 19:36:05 +01:00
|
|
|
* @return BundleInterface A BundleInterface instance
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException when the bundle is not enabled
|
|
|
|
*/
|
2017-09-11 19:36:05 +01:00
|
|
|
public function getBundle($name);
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
2018-03-09 14:05:02 +00:00
|
|
|
* Returns the file path for a given bundle resource.
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
|
|
|
* A Resource can be a file or a directory.
|
|
|
|
*
|
|
|
|
* The resource name must follow the following pattern:
|
|
|
|
*
|
2015-01-04 18:14:50 +00:00
|
|
|
* "@BundleName/path/to/a/file.something"
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
|
|
|
* where BundleName is the name of the bundle
|
|
|
|
* and the remaining part is the relative path in the bundle.
|
|
|
|
*
|
2019-08-20 15:47:04 +01:00
|
|
|
* @param string $name A resource name to locate
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
2019-08-20 15:47:04 +01:00
|
|
|
* @return string|array The absolute path of the resource or an array if $first is false (array return value is deprecated)
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the file cannot be found or the name is not valid
|
|
|
|
* @throws \RuntimeException if the name contains invalid/unsafe characters
|
|
|
|
*/
|
2019-08-20 15:47:04 +01:00
|
|
|
public function locateResource($name/*, $dir = null, $first = true*/);
|
2011-01-25 16:07:37 +00:00
|
|
|
|
2011-02-24 13:02:28 +00:00
|
|
|
/**
|
2014-03-24 15:32:55 +00:00
|
|
|
* Gets the name of the kernel.
|
2011-02-24 13:02:28 +00:00
|
|
|
*
|
|
|
|
* @return string The kernel name
|
2018-10-10 15:41:53 +01:00
|
|
|
*
|
|
|
|
* @deprecated since Symfony 4.2
|
2011-02-24 13:02:28 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getName();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the environment.
|
|
|
|
*
|
|
|
|
* @return string The current environment
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getEnvironment();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks if debug mode is enabled.
|
|
|
|
*
|
2014-11-30 13:33:44 +00:00
|
|
|
* @return bool true if debug mode is enabled, false otherwise
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function isDebug();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
2017-04-04 05:27:20 +01:00
|
|
|
* Gets the application root dir (path of the project's Kernel class).
|
2011-01-25 16:07:37 +00:00
|
|
|
*
|
2017-04-04 05:27:20 +01:00
|
|
|
* @return string The Kernel root dir
|
2018-10-16 14:47:03 +01:00
|
|
|
*
|
|
|
|
* @deprecated since Symfony 4.2
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getRootDir();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the current container.
|
|
|
|
*
|
2019-04-23 07:04:30 +01:00
|
|
|
* @return ContainerInterface
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getContainer();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the request start time (not available if debug is disabled).
|
|
|
|
*
|
2019-08-23 12:30:52 +01:00
|
|
|
* @return float The request start timestamp
|
2011-01-25 16:07:37 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getStartTime();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the cache directory.
|
|
|
|
*
|
|
|
|
* @return string The cache directory
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getCacheDir();
|
2011-01-25 16:07:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the log directory.
|
|
|
|
*
|
|
|
|
* @return string The log directory
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getLogDir();
|
2012-07-03 08:10:12 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the charset of the application.
|
|
|
|
*
|
|
|
|
* @return string The charset
|
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function getCharset();
|
2011-01-25 16:07:37 +00:00
|
|
|
}
|