Spec-Zone.ru › Symfony 4.1

KernelInterface

интерфейс KernelInterface реализует HttpKernelInterface, Serializable

Ядро — сердце системы Symfony.

Он управляет средой, состоящей из ядра приложения и пакетов.

Методы

Response handle(Request $request, int $type = self::MASTER_REQUEST, bool $catch = true)

Обрабатывает запрос для его преобразования в ответ.

из HttpKernelInterface
iterable|BundleInterface[] registerBundles()

Возвращает массив пакетов для регистрации.

registerContainerConfiguration(LoaderInterface $loader)

Загружает конфигурацию контейнера.

boot()

Запускает текущее ядро.

shutdown()

Выключает ядро.

BundleInterface[] getBundles()

Получает зарегистрированные экземпляры пакетов.

BundleInterface getBundle(string $name)

Возвращает пакет.

string|array locateResource(string $name, string $dir = null, bool $first = true)

Возвращает путь к файлу для данного ресурса пакета.

string getName()

Получает имя ядра.

string getEnvironment()

Получает среду.

bool isDebug()

Проверяет, включен ли режим отладки.

string getRootDir()

Получает корневой каталог приложения (путь к классу Kernel проекта).

ContainerInterface|null 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 При возникновении исключения во время обработки

iterable|BundleInterface[] registerBundles()

Возвращает массив пакетов для регистрации.

Значение возврата

iterable|BundleInterface[] Итерируемый объект экземпляров пакетов

registerContainerConfiguration(LoaderInterface $loader)

Загружает конфигурацию контейнера.

Параметры

LoaderInterface $loader

boot()

Запускает текущее ядро.

shutdown()

Выключает ядро.

Этот метод полезен, в основном, при функциональном тестировании.

BundleInterface[] getBundles()

Получает зарегистрированные экземпляры пакетов.

Значение возврата

BundleInterface[] Массив зарегистрированных экземпляров пакетов

BundleInterface getBundle(string $name)

Возвращает пакет.

Параметры

string $name Имя пакета

Значение возврата

BundleInterface Экземпляр BundleInterface

Исключения

InvalidArgumentException если пакет не включен

string|array locateResource(string $name, string $dir = null, bool $first = true)

Возвращает путь к файлу для заданного ресурса пакета.

Ресурс может быть файлом или каталогом.

Имя ресурса должно соответствовать следующему шаблону:

"@BundleName/path/to/a/file.something"

где ИмяПакеты - имя пакета, а оставшаяся часть - относительный путь в пакете.

Если $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()

Возвращает корневой каталог приложения (путь к классу Kernel проекта).

Значение возврата

string Корневой каталог Kernel

ContainerInterface|null getContainer()

Возвращает текущий контейнер.

Значение возврата

ContainerInterface|null Экземпляр ContainerInterface или null, когда ядро выключено

int getStartTime()

Возвращает время начала запроса (недоступно, если отладка отключена).

Значение возврата

int Маркер времени начала запроса

string getCacheDir()

Возвращает каталог кэша.

Значение возврата

string Каталог кэша

string getLogDir()

Возвращает каталог логов.

Значение возврата

string Каталог логов

string getCharset()

Возвращает кодировку приложения.

Значение возврата

string Кодировка

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/KernelInterface.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API