Spec-Zone.ru › Symfony 4.1

ControllerTrait

trait ControllerTrait

Общие возможности, необходимые в контроллерах.

Свойства

ContainerInterface $container

Методы

bool has(string $id)

Возвращает true, если идентификатор сервиса определен.

object get(string $id)

Получает сервис контейнера по его идентификатору.

string generateUrl(string $route, array $parameters = array(), int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Генерирует URL на основе заданных параметров.

Response forward(string $controller, array $path = array(), array $query = array())

Перенаправляет запрос на другой контроллер.

RedirectResponse redirect(string $url, int $status = 302)

Возвращает RedirectResponse на указанный URL.

RedirectResponse redirectToRoute(string $route, array $parameters = array(), int $status = 302)

Возвращает RedirectResponse на указанный маршрут с заданными параметрами.

JsonResponse json($data, int $status = 200, array $headers = array(), array $context = array())

Возвращает JsonResponse, использующий компонент сериализации, если он включён, или json_encode.

BinaryFileResponse file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT)

Возвращает объект BinaryFileResponse с исходным или настроенным именем файла и заголовком disposition.

addFlash(string $type, string $message)

Добавляет сообщение флэша в текущую сессию для типа.

bool isGranted($attributes, $subject = null)

Проверяет, предоставлены ли атрибуты по отношению к текущему токену аутентификации и, необязательно, указанному субъекту.

denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')

Выбрасывает исключение, если атрибуты не предоставлены для текущего токена аутентификации и, необязательно, указанного субъекта.

string renderView(string $view, array $parameters = array())

Возвращает отрисованный вид.

Response render(string $view, array $parameters = array(), Response $response = null)

Отрисовывает вид.

StreamedResponse stream(string $view, array $parameters = array(), StreamedResponse $response = null)

Выводит вид в виде потока.

NotFoundHttpException createNotFoundException(string $message = 'Not Found', Exception $previous = null)

Возвращает NotFoundHttpException.

AccessDeniedException createAccessDeniedException(string $message = 'Access Denied.', Exception $previous = null)

Возвращает AccessDeniedException.

FormInterface createForm(string $type, $data = null, array $options = array())

Создаёт и возвращает экземпляр Form из типа формы.

FormBuilderInterface createFormBuilder($data = null, array $options = array())

Создаёт и возвращает экземпляр FormBuilder.

ManagerRegistry getDoctrine()

Сокращённый способ вернуть сервис Doctrine Registry.

mixed getUser()

Получить пользователя из хранилища Security Token.

bool isCsrfTokenValid(string $id, string|null $token)

Проверяет корректность токена CSRF.

dispatchMessage(object $message)

Отправляет сообщение в очередь.

Подробности

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 с исходным или настраиваемым именем файла и заголовком расположения.

Параметры

$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.

Возвращаемое значение

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 Сообщение для отправки

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.html

Spec-Zone.ru

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