KernelInterface
интерфейс KernelInterface реализует HttpKernelInterface, Serializable
Ядро — сердце системы Symfony.
Он управляет средой, состоящей из пакетов.
Методы
| Response | handle(Request $request, int $type = self::MASTER_REQUEST, bool $catch = true) Обрабатывает запрос, чтобы преобразовать его в ответ. | из HttpKernelInterface |
| BundleInterface[] | registerBundles() Возвращает массив пакетов для регистрации. | |
| registerContainerConfiguration(LoaderInterface $loader) Загружает конфигурацию контейнера. | ||
| boot() Запускает текущее ядро. | ||
| shutdown() Выключает ядро. | ||
| BundleInterface[] | getBundles() Получает зарегистрированные экземпляры пакетов. | |
| BundleInterface|BundleInterface[] | getBundle(string $name, bool $first = true) Возвращает пакет и, по желанию, его потомков по его имени. | |
| string|array | locateResource(string $name, string $dir = null, bool $first = true) Возвращает путь к файлу для данного ресурса. | |
| string | getName() Получает имя ядра. | |
| string | getEnvironment() Получает среду. | |
| bool | isDebug() Проверяет, включен ли режим отладки. | |
| string | getRootDir() Получает корневой каталог приложения. | |
| ContainerInterface | getContainer() Получает текущий контейнер. | |
| int | getStartTime() Получает время начала запроса (не доступно, если отладка отключена). | |
| string | getCacheDir() Получает каталог кэша. | |
| string | getLogDir() Получает каталог логов. | |
| string | getCharset() Получает кодировку приложения. |
Подробности
Response handle(Request $request, int $type = self::MASTER_REQUEST, bool $catch = true)
Обрабатывает запрос для преобразования его в ответ.
Когда $catch имеет значение true, реализация должна перехватывать все исключения и по возможности преобразовывать их в экземпляр Response.
Параметры
| Request | $request | Экземпляр Request |
| int | $type | Тип запроса (один из HttpKernelInterface::MASTER_REQUEST или HttpKernelInterface::SUB_REQUEST) |
| bool | $catch | Перехватывать исключения или нет |
Возвращаемое значение
| Response | Экземпляр Response |
Исключения
| Exception | При возникновении исключения во время обработки |
BundleInterface[] registerBundles()
Возвращает массив пакетов для регистрации.
Возвращаемое значение
| BundleInterface[] | Массив экземпляров пакетов |
registerContainerConfiguration(LoaderInterface $loader)
Загружает конфигурацию контейнера.
Параметры
| LoaderInterface | $loader | Экземпляр LoaderInterface |
boot()
Запускает текущее ядро.
shutdown()
Выключает ядро.
Этот метод в основном полезен при функциональном тестировании.
BundleInterface[] getBundles()
Получает зарегистрированные экземпляры пакетов.
Возвращаемое значение
| BundleInterface[] | Массив зарегистрированных экземпляров пакетов |
BundleInterface|BundleInterface[] getBundle(string $name, bool $first = true)
Возвращает пакет и, необязательно, его потомков по его имени.
Параметры
| string | $name | Имя пакета |
| bool | $first | Возвращать только первый пакет или вместе с его потомками |
Возвращаемое значение
| BundleInterface|BundleInterface[] | Экземпляр BundleInterface или массив экземпляров BundleInterface, если $first имеет значение false |
Исключения
| InvalidArgumentException | при отсутствии включенного пакета |
string|array locateResource(string $name, string $dir = null, bool $first = true)
Возвращает путь к файлу для заданного ресурса.
Ресурсом может быть файл или каталог.
Имя ресурса должно соответствовать следующему шаблону:
"@BundleName/path/to/a/file.something"
где BundleName — имя пакета, а оставшаяся часть — относительный путь внутри пакета.
Если $dir передан и первый сегмент пути — "Resources", этот метод будет искать файл с именем:
$dir/<BundleName>/path/without/Resources
перед поиском в папке ресурсов пакета.
Параметры
| string | $name | Имя искомого ресурса |
| string | $dir | Каталог, в котором нужно искать ресурс в первую очередь |
| bool | $first | Возвращать первый путь или пути для всех соответствующих пакетов |
Возвращаемое значение
| string|array | Абсолютный путь к ресурсу или массив, если $first имеет значение false |
Исключения
| InvalidArgumentException | если файл не найден или имя некорректно |
| RuntimeException | если имя содержит недопустимые/опасные символы |
string getName()
Получает имя ядра.
Возвращаемое значение
| string | Имя ядра |
string getEnvironment()
Получает среду.
Возвращаемое значение
| string | Текущая среда |
bool isDebug()
Проверяет, включен ли режим отладки.
Возвращаемое значение
| bool | true, если режим отладки включен, иначе false |
string getRootDir()
Получает корневой каталог приложения.
Возвращаемое значение
| string | Корневой каталог приложения |
ContainerInterface getContainer()
Получает текущий контейнер.
Возвращаемое значение
| ContainerInterface | Экземпляр ContainerInterface |
int getStartTime()
Получает время начала запроса (не доступно, если отладка отключена).
Возвращаемое значение
| int | Отметка времени начала запроса |
string getCacheDir()
Получает каталог кэша.
Возвращаемое значение
| string | Каталог кэша |
string getLogDir()
Получает каталог журналов.
Возвращаемое значение
| string | Каталог журналов |
string getCharset()
Получает кодировку приложения.
Возвращаемое значение
| string | Кодировка |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/HttpKernel/KernelInterface.html