AbstractController
абстрактный класс AbstractController реализует ServiceSubscriberInterface
Предоставляет общие функции, необходимые в контроллерах.
Свойства
| ControllerTrait | Общие функции, необходимые в контроллерах. |
Свойства
| protected ContainerInterface | $container |
Методы
| 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) Добавляет сообщение flash в текущую сессию для типа. | из 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()) Создаёт и возвращает экземпляр формы по типу формы. | из ControllerTrait |
| FormBuilderInterface | createFormBuilder($data = null, array $options = array()) Создаёт и возвращает экземпляр билдера формы. | из ControllerTrait |
| ManagerRegistry | getDoctrine() Короткая форма получения сервиса Doctrine Registry. | из ControllerTrait |
| mixed | getUser() Получить пользователя из хранилища токена безопасности. | из ControllerTrait |
| bool | isCsrfTokenValid(string $id, string|null $token) Проверяет валидность токена CSRF. | из ControllerTrait |
| dispatchMessage(object $message) Отправляет сообщение в очередь. | из ControllerTrait | |
| setContainer(ContainerInterface $container) | ||
| mixed | getParameter(string $name) Получает параметр контейнера по его имени. | |
| static array | getSubscribedServices() Возвращает массив типов сервисов, необходимых для таких экземпляров, необязательно индексированных именами сервисов, используемых внутри. |
Подробности
protected bool has(string $id)
Возвращает true, если идентификатор сервиса определён.
Параметры
| string | $id |
Возвращаемое значение
| bool |
protected object get(string $id)
Получает контейнерный сервис по его идентификатору.
Параметры
| string | $id |
Возвращаемое значение
| object | Сервис |
protected string generateUrl(string $route, array $parameters = array(), int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
Генерирует URL на основе заданных параметров.
Параметры
| string | $route | |
| array | $parameters | |
| int | $referenceType |
Возвращаемое значение
| string |
См. также
| UrlGeneratorInterface |
protected Response forward(string $controller, array $path = array(), array $query = array())
Перенаправляет запрос на другой контроллер.
Параметры
| string | $controller | |
| array | $path | |
| array | $query |
Возвращаемое значение
| Response |
protected RedirectResponse redirect(string $url, int $status = 302)
Возвращает RedirectResponse по заданному URL.
Параметры
| string | $url | |
| int | $status |
Возвращаемое значение
| RedirectResponse |
protected RedirectResponse redirectToRoute(string $route, array $parameters = array(), int $status = 302)
Возвращает RedirectResponse по заданному маршруту с заданными параметрами.
Параметры
| string | $route | |
| array | $parameters | |
| int | $status |
Возвращаемое значение
| RedirectResponse |
protected JsonResponse json($data, int $status = 200, array $headers = array(), array $context = array())
Возвращает JsonResponse, использующий компонент сериализации, если он включён, или json_encode.
Параметры
| $data | ||
| int | $status | |
| array | $headers | |
| array | $context |
Возвращаемое значение
| JsonResponse |
protected BinaryFileResponse file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT)
Возвращает объект BinaryFileResponse с исходным или настроенным именем файла и заголовком disposition.
Параметры
| $file | ||
| string | $fileName | |
| string | $disposition |
Возвращаемое значение
| BinaryFileResponse |
protected addFlash(string $type, string $message)
Добавляет сообщение всплывающей подсказки в текущую сессию для типа.
Параметры
| string | $type | |
| string | $message |
Исключения
| LogicException |
protected bool isGranted($attributes, $subject = null)
Проверяет, предоставлены ли атрибуты в контексте текущего токена аутентификации и, необязательно, предоставленного субъекта.
Параметры
| $attributes | ||
| $subject |
Возвращаемое значение
| bool |
Исключения
| LogicException |
protected denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')
Выбрасывает исключение, если атрибуты не предоставлены в контексте текущего токена аутентификации и, необязательно, предоставленного субъекта.
Параметры
| $attributes | ||
| $subject | ||
| string | $message |
Исключения
| AccessDeniedException |
protected string renderView(string $view, array $parameters = array())
Возвращает отрендеренный вид.
Параметры
| string | $view | |
| array | $parameters |
Возвращаемое значение
| string |
protected Response render(string $view, array $parameters = array(), Response $response = null)
Рендерит вид.
Параметры
| string | $view | |
| array | $parameters | |
| Response | $response |
Возвращаемое значение
| Response |
protected StreamedResponse stream(string $view, array $parameters = array(), StreamedResponse $response = null)
Потоковая передача вида.
Параметры
| string | $view | |
| array | $parameters | |
| StreamedResponse | $response |
Возвращаемое значение
| StreamedResponse |
protected NotFoundHttpException createNotFoundException(string $message = 'Not Found', Exception $previous = null)
Возвращает NotFoundHttpException.
Это приведет к ответу со статусом 404. Пример использования:
throw $this->createNotFoundException('Page not found!');
Параметры
| string | $message | |
| Exception | $previous |
Возвращаемое значение
| NotFoundHttpException |
protected AccessDeniedException createAccessDeniedException(string $message = 'Access Denied.', Exception $previous = null)
Возвращает AccessDeniedException.
Это приведет к ответу со статусом 403. Пример использования:
throw $this->createAccessDeniedException('Unable to access this page!');
Параметры
| string | $message | |
| Exception | $previous |
Возвращаемое значение
| AccessDeniedException |
Исключения
| LogicException | Если компонент Security недоступен |
protected FormInterface createForm(string $type, $data = null, array $options = array())
Создает и возвращает экземпляр формы на основе типа формы.
Параметры
| string | $type | |
| $data | ||
| array | $options |
Значение возврата
| FormInterface |
protected FormBuilderInterface createFormBuilder($data = null, array $options = array())
Создает и возвращает экземпляр билдера формы.
Параметры
| $data | ||
| array | $options |
Значение возврата
| FormBuilderInterface |
protected ManagerRegistry getDoctrine()
Сокращенная запись для возвращения сервиса Doctrine Registry.
Значение возврата
| ManagerRegistry |
Исключения
| LogicException | Если DoctrineBundle недоступен |
protected mixed getUser()
Получение пользователя из хранилища токена безопасности.
Значение возврата
| mixed |
Исключения
| LogicException | Если SecurityBundle недоступен |
См. также
| TokenInterface::getUser() |
protected bool isCsrfTokenValid(string $id, string|null $token)
Проверка валидности токена CSRF.
Параметры
| string | $id | Идентификатор, используемый при генерации токена |
| string|null | $token | Фактический токен, отправленный с запросом, который должен быть проверен |
Значение возврата
| bool |
protected dispatchMessage(object $message)
Отправка сообщения в шину.
Параметры
| object | $message | Сообщение для отправки |
setContainer(ContainerInterface $container)
Параметры
| ContainerInterface | $container |
protected mixed getParameter(string $name)
Получение параметра контейнера по его имени.
Параметры
| string | $name |
Значение возврата
| mixed |
static array getSubscribedServices()
Возвращает массив типов сервисов, необходимых для таких экземпляров, необязательно с ключами, используемыми внутри для имен сервисов.
Для обязательных зависимостей:
- array('logger' => 'Psr\Log\LoggerInterface') означает, что объекты используют имя "logger" внутри для получения сервиса, который должен реализовывать Psr\Log\LoggerInterface.
- array('Psr\Log\LoggerInterface') — сокращение для
- array('Psr\Log\LoggerInterface' => 'Psr\Log\LoggerInterface')
в противном случае:
- array('logger' => '?Psr\Log\LoggerInterface') обозначает необязательную зависимость
- array('?Psr\Log\LoggerInterface') — сокращение для
- array('Psr\Log\LoggerInterface' => '?Psr\Log\LoggerInterface')
Значение возврата
| array | Требуемые типы сервисов, необязательно с ключами по именам сервисов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.html