Контроллер
абстрактный класс Контроллер реализует ContainerAwareInterface
Контроллер — простое реализация контроллера.
Он предоставляет методы для общих функций, необходимых в контроллерах.
Трейты
Свойства
Методы
| | setContainer(ContainerInterface $container = null) | из ContainerAwareTrait |
| bool | has(string $id) Возвращает true, если идентификатор сервиса определён. | из ControllerTrait |
| object | get(string $id) Получает сервис контейнера по его идентификатору. | из ControllerTrait |
| string | generateUrl(string $route, array $parameters = array(), int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH) Генерирует URL из заданных параметров. | из ControllerTrait |
| Response | forward(string $controller, array $path = array(), array $query = array()) Перенаправляет запрос на другой контроллер. | из ControllerTrait |
| RedirectResponse | redirect(string $url, int $status = 302) Возвращает RedirectResponse на заданный URL. | из ControllerTrait |
| RedirectResponse | redirectToRoute(string $route, array $parameters = array(), int $status = 302) Возвращает RedirectResponse на заданный маршрут с заданными параметрами. | из ControllerTrait |
| JsonResponse | json($data, int $status = 200, array $headers = array(), array $context = array()) Возвращает JsonResponse, использующий компонент сериализации, если он включён, или json_encode. | из ControllerTrait |
| BinaryFileResponse | file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT) Возвращает объект BinaryFileResponse с исходным или настроенным именем файла и заголовком disposition. | из ControllerTrait |
| | addFlash(string $type, string $message) Добавляет сообщение всплывающей подсказки в текущую сессию для типа. | из ControllerTrait |
| bool | isGranted($attributes, $subject = null) Проверяет, предоставлены ли атрибуты в контексте текущего токена аутентификации и, необязательно, предоставленного субъекта. | из ControllerTrait |
| | denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.') Выбрасывает исключение, если атрибуты не предоставлены в контексте текущего токена аутентификации и, необязательно, предоставленного субъекта. | из ControllerTrait |
| string | renderView(string $view, array $parameters = array()) Возвращает отрисованный вид. | из ControllerTrait |
| Response | render(string $view, array $parameters = array(), Response $response = null) Отрисовывает представление. | из ControllerTrait |
| StreamedResponse | stream(string $view, array $parameters = array(), StreamedResponse $response = null) Выводит представление в виде потока. | из ControllerTrait |
| NotFoundHttpException | createNotFoundException(string $message = 'Not Found', Exception $previous = null) Возвращает NotFoundHttpException. | из ControllerTrait |
| AccessDeniedException | createAccessDeniedException(string $message = 'Access Denied.', Exception $previous = null) Возвращает AccessDeniedException. | из ControllerTrait |
| FormInterface | createForm(string $type, $data = null, array $options = array()) Создаёт и возвращает экземпляр Form из типа формы. | из ControllerTrait |
| FormBuilderInterface | createFormBuilder($data = null, array $options = array()) Создаёт и возвращает экземпляр form builder. | из ControllerTrait |
| ManagerRegistry | getDoctrine() Сокращённая запись для возврата сервиса Doctrine Registry. | из ControllerTrait |
| mixed | getUser() Получает пользователя из хранилища Security Token. | из ControllerTrait |
| bool | isCsrfTokenValid(string $id, string|null $token) Проверяет валидность CSRF токена. | из ControllerTrait |
| | dispatchMessage(object $message) Отправляет сообщение в очередь. | из ControllerTrait |
| mixed | getParameter(string $name) Получает параметр конфигурации контейнера по его имени. | |
Подробности
Параметры
protected bool
has(string $id)
Возвращает true, если идентификатор сервиса определён.
Параметры
Возвращаемое значение
protected object
get(string $id)
Получает сервис контейнера по его идентификатору.
Параметры
Возвращаемое значение
protected string
generateUrl(string $route, array $parameters = array(), int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
Генерирует URL по заданным параметрам.
Параметры
| string | $route | |
| array | $parameters | |
| int | $referenceType | |
Возвращаемое значение
См. также
protected Response
forward(string $controller, array $path = array(), array $query = array())
Перенаправляет запрос на другой контроллер.
Параметры
| string | $controller | |
| array | $path | |
| array | $query | |
Возвращаемое значение
protected RedirectResponse
redirect(string $url, int $status = 302)
Возвращает RedirectResponse на заданный URL.
Параметры
Возвращаемое значение
protected RedirectResponse
redirectToRoute(string $route, array $parameters = array(), int $status = 302)
Возвращает RedirectResponse на заданный маршрут с заданными параметрами.
Параметры
| string | $route | |
| array | $parameters | |
| int | $status | |
Возвращаемое значение
protected JsonResponse
json($data, int $status = 200, array $headers = array(), array $context = array())
Возвращает JsonResponse, использующий компонент сериализации, если он включён, или json_encode.
Параметры
| $data | |
| int | $status | |
| array | $headers | |
| array | $context | |
Возвращаемое значение
protected BinaryFileResponse
file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT)
Возвращает объект BinaryFileResponse с исходным или настроенным именем файла и заголовком disposition.
Параметры
| $file | |
| string | $fileName | |
| string | $disposition | |
Возвращаемое значение
protected
addFlash(string $type, string $message)
Добавляет сообщение flash в текущую сессию для типа.
Параметры
| string | $type | |
| string | $message | |
Исключения
protected bool
isGranted($attributes, $subject = null)
Проверяет, предоставлены ли атрибуты текущему токену аутентификации и, необязательно, предоставленному предмету.
Параметры
Возвращаемое значение
Исключения
protected
denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')
Выбрасывает исключение, если атрибуты не предоставлены текущему токену аутентификации и, необязательно, предоставленному предмету.
Параметры
| $attributes | |
| $subject | |
| string | $message | |
Исключения
protected string
renderView(string $view, array $parameters = array())
Возвращает рендер виджета.
Параметры
| string | $view | |
| array | $parameters | |
Возвращаемое значение
protected Response
render(string $view, array $parameters = array(), Response $response = null)
Рендерит виджет.
Параметры
| string | $view | |
| array | $parameters | |
| Response | $response | |
Возвращаемое значение
protected StreamedResponse
stream(string $view, array $parameters = array(), StreamedResponse $response = null)
Потоковый вывод виджета.
Параметры
Возвращаемое значение
protected NotFoundHttpException
createNotFoundException(string $message = 'Not Found', Exception $previous = null)
Возвращает NotFoundHttpException.
Это приведет к ответу со статусом 404. Пример использования:
throw $this->createNotFoundException('Page not found!');
Параметры
Возвращаемое значение
protected AccessDeniedException
createAccessDeniedException(string $message = 'Отказ в доступе.', Exception $previous = null)
Возвращает AccessDeniedException.
Это приведёт к ответу с кодом 403. Пример использования:
throw $this->createAccessDeniedException('Unable to access this page!');
Параметры
Возвращаемое значение
Исключения
Создаёт и возвращает экземпляр Form на основе типа формы.
Параметры
| string | $type | |
| $data | |
| array | $options | |
Возвращаемое значение
Создаёт и возвращает экземпляр form builder.
Параметры
Возвращаемое значение
protected ManagerRegistry
getDoctrine()
Сокращение для возвращения сервиса Doctrine Registry.
Возвращаемое значение
Исключения
protected mixed
getUser()
Получение пользователя из хранилища Security Token.
Возвращаемое значение
Исключения
См. также
| TokenInterface::getUser() | |
protected bool
isCsrfTokenValid(string $id, string|null $token)
Проверка валидности CSRF-токена.
Параметры
| string | $id | Идентификатор, используемый при генерации токена |
| string|null | $token | Сам токен, отправленный с запросом для проверки |
Возвращаемое значение
protected
dispatchMessage(object $message)
Отправка сообщения в очередь.
Параметры
| object | $message | Сообщения для отправки |
protected mixed
getParameter(string $name)
Получение параметра конфигурации контейнера по имени.
Параметры
Возвращаемое значение