trait ControllerTrait

Common features needed in controllers.

Properties

ContainerInterface $container

Methods

bool
has(string $id)

Returns true if the service id is defined.

object
get(string $id)

Gets a container service by its id.

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

Generates a URL from the given parameters.

forward(string $controller, array $path = [], array $query = [])

Forwards the request to another controller.

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

Returns a RedirectResponse to the given URL.

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

Returns a RedirectResponse to the given route with the given parameters.

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

Returns a JsonResponse that uses the serializer component if enabled, or json_encode.

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

Returns a BinaryFileResponse object with original or customized file name and disposition header.

addFlash(string $type, string $message)

Adds a flash message to the current session for type.

bool
isGranted($attributes, $subject = null)

Checks if the attributes are granted against the current authentication token and optionally supplied subject.

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

Throws an exception unless the attributes are granted against the current authentication token and optionally supplied subject.

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

Returns a rendered view.

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

Renders a view.

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

Streams a view.

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

Returns a NotFoundHttpException.

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

Returns an AccessDeniedException.

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

Creates and returns a Form instance from the type of the form.

createFormBuilder($data = null, array $options = [])

Creates and returns a form builder instance.

ManagerRegistry
getDoctrine()

Shortcut to return the Doctrine Registry service.

mixed
getUser()

Get a user from the Security Token Storage.

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

Checks the validity of a CSRF token.

dispatchMessage(object $message)

Dispatches a message to the bus.

Details

at line 47
protected bool has(string $id)

Returns true if the service id is defined.

Parameters

string $id

Return Value

bool

at line 59
protected object get(string $id)

Gets a container service by its id.

Parameters

string $id

Return Value

object The service

at line 71
protected string generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generates a URL from the given parameters.

Parameters

string $route
array $parameters
int $referenceType

Return Value

string

See also

UrlGeneratorInterface

at line 83
protected Response forward(string $controller, array $path = [], array $query = [])

Forwards the request to another controller.

Parameters

string $controller
array $path
array $query

Return Value

Response

at line 97
protected RedirectResponse redirect(string $url, int $status = 302)

Returns a RedirectResponse to the given URL.

Parameters

string $url
int $status

Return Value

RedirectResponse

at line 107
protected RedirectResponse redirectToRoute(string $route, array $parameters = [], int $status = 302)

Returns a RedirectResponse to the given route with the given parameters.

Parameters

string $route
array $parameters
int $status

Return Value

RedirectResponse

at line 117
protected JsonResponse json($data, int $status = 200, array $headers = [], array $context = [])

Returns a JsonResponse that uses the serializer component if enabled, or json_encode.

Parameters

$data
int $status
array $headers
array $context

Return Value

JsonResponse

at line 137
protected BinaryFileResponse file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT)

Returns a BinaryFileResponse object with original or customized file name and disposition header.

Parameters

$file
string $fileName
string $disposition

Return Value

BinaryFileResponse

at line 152
protected addFlash(string $type, string $message)

Adds a flash message to the current session for type.

Parameters

string $type
string $message

Exceptions

LogicException

at line 168
protected bool isGranted($attributes, $subject = null)

Checks if the attributes are granted against the current authentication token and optionally supplied subject.

Parameters

$attributes
$subject

Return Value

bool

Exceptions

LogicException

at line 185
protected denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')

Throws an exception unless the attributes are granted against the current authentication token and optionally supplied subject.

Parameters

$attributes
$subject
string $message

Exceptions

AccessDeniedException

at line 201
protected string renderView(string $view, array $parameters = [])

Returns a rendered view.

Parameters

string $view
array $parameters

Return Value

string

at line 219
protected Response render(string $view, array $parameters = [], Response $response = null)

Renders a view.

Parameters

string $view
array $parameters
Response $response

Return Value

Response

at line 243
protected StreamedResponse stream(string $view, array $parameters = [], StreamedResponse $response = null)

Streams a view.

Parameters

string $view
array $parameters
StreamedResponse $response

Return Value

StreamedResponse

at line 279
protected NotFoundHttpException createNotFoundException(string $message = 'Not Found', Exception $previous = null)

Returns a NotFoundHttpException.

This will result in a 404 response code. Usage example:

throw $this->createNotFoundException('Page not found!');

Parameters

string $message
Exception $previous

Return Value

NotFoundHttpException

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

Returns an AccessDeniedException.

This will result in a 403 response code. Usage example:

throw $this->createAccessDeniedException('Unable to access this page!');

Parameters

string $message
Exception $previous

Return Value

AccessDeniedException

Exceptions

LogicException If the Security component is not available

at line 309
protected FormInterface createForm(string $type, $data = null, array $options = [])

Creates and returns a Form instance from the type of the form.

Parameters

string $type
$data
array $options

Return Value

FormInterface

at line 319
protected FormBuilderInterface createFormBuilder($data = null, array $options = [])

Creates and returns a form builder instance.

Parameters

$data
array $options

Return Value

FormBuilderInterface

at line 331
protected ManagerRegistry getDoctrine()

Shortcut to return the Doctrine Registry service.

Return Value

ManagerRegistry

Exceptions

LogicException If DoctrineBundle is not available

at line 351
protected mixed getUser()

Get a user from the Security Token Storage.

Return Value

mixed

Exceptions

LogicException If SecurityBundle is not available

See also

TokenInterface::getUser()

at line 377
protected bool isCsrfTokenValid(string $id, string|null $token)

Checks the validity of a CSRF token.

Parameters

string $id The id used when generating the token
string|null $token The actual token sent with the request that should be validated

Return Value

bool

at line 393
protected dispatchMessage(object $message)

Dispatches a message to the bus.

Parameters

object $message The message to dispatch