Spec-Zone.ru › Symfony 3.1

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.1/Symfony/Component/HttpKernel/KernelInterface.html

Spec-Zone.ru

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