class Controller extends ContainerAware

Controller is a simple implementation of a Controller.

It provides methods to common features needed in controllers.

Properties

protected ContainerInterface $container from ContainerAware

Methods

setContainer(ContainerInterface $container = null)

Sets the container.

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

Generates a URL from the given parameters.

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

Forwards the request to another controller.

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

Returns a RedirectResponse to the given URL.

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

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

addFlash(string $type, string $message)

Adds a flash message to the current session for type.

bool
isGranted(mixed $attributes, mixed $object = null)

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

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

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

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

Returns a rendered view.

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

Renders a view.

stream(string $view, array $parameters = array(), 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|FormTypeInterface $type, mixed $data = null, array $options = array())

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

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

Creates and returns a form builder instance.

getRequest() deprecated

Shortcut to return the request service.

Registry
getDoctrine()

Shortcut to return the Doctrine Registry service.

mixed
getUser()

Get a user from the Security Token Storage.

bool
has(string $id)

Returns true if the service id is defined.

object
get(string $id)

Gets a container service by its id.

mixed
getParameter(string $name)

Gets a container configuration parameter by its name.

bool
isCsrfTokenValid(string $id, string $token)

Checks the validity of a CSRF token.

Details

in ContainerAware at line 31
setContainer(ContainerInterface $container = null)

Sets the container.

Parameters

ContainerInterface $container

at line 50
string generateUrl(string $route, mixed $parameters = array(), int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generates a URL from the given parameters.

Parameters

string $route The name of the route
mixed $parameters An array of parameters
int $referenceType The type of reference (one of the constants in UrlGeneratorInterface)

Return Value

string The generated URL

See also

UrlGeneratorInterface

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

Forwards the request to another controller.

Parameters

string $controller The controller name (a string like BlogBundle:Post:index)
array $path An array of path parameters
array $query An array of query parameters

Return Value

Response A Response instance

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

Returns a RedirectResponse to the given URL.

Parameters

string $url The URL to redirect to
int $status The status code to use for the Response

Return Value

RedirectResponse

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

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

Parameters

string $route The name of the route
array $parameters An array of parameters
int $status The status code to use for the Response

Return Value

RedirectResponse

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

Adds a flash message to the current session for type.

Parameters

string $type The type
string $message The message

Exceptions

LogicException

at line 126
protected bool isGranted(mixed $attributes, mixed $object = null)

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

Parameters

mixed $attributes The attributes
mixed $object The object

Return Value

bool

Exceptions

LogicException

at line 145
protected denyAccessUnlessGranted(mixed $attributes, mixed $object = null, string $message = 'Access Denied.')

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

Parameters

mixed $attributes The attributes
mixed $object The object
string $message The message passed to the exception

Exceptions

AccessDeniedException

at line 160
string renderView(string $view, array $parameters = array())

Returns a rendered view.

Parameters

string $view The view name
array $parameters An array of parameters to pass to the view

Return Value

string The rendered view

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

Renders a view.

Parameters

string $view The view name
array $parameters An array of parameters to pass to the view
Response $response A response instance

Return Value

Response A Response instance

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

Streams a view.

Parameters

string $view The view name
array $parameters An array of parameters to pass to the view
StreamedResponse $response A response instance

Return Value

StreamedResponse A StreamedResponse instance

at line 249
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 A message
Exception $previous The previous exception

Return Value

NotFoundHttpException

at line 266
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 A message
Exception $previous The previous exception

Return Value

AccessDeniedException

at line 280
Form createForm(string|FormTypeInterface $type, mixed $data = null, array $options = array())

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

Parameters

string|FormTypeInterface $type The built type of the form
mixed $data The initial data for the form
array $options Options for the form

Return Value

Form

at line 293
FormBuilder createFormBuilder(mixed $data = null, array $options = array())

Creates and returns a form builder instance.

Parameters

mixed $data The initial data for the form
array $options Options for the form

Return Value

FormBuilder

at line 316
Request getRequest() deprecated

deprecated since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature.

Shortcut to return the request service.

Return Value

Request

at line 330
Registry getDoctrine()

Shortcut to return the Doctrine Registry service.

Return Value

Registry

Exceptions

LogicException If DoctrineBundle is not available

at line 348
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 373
bool has(string $id)

Returns true if the service id is defined.

Parameters

string $id The service id

Return Value

bool true if the service id is defined, false otherwise

at line 385
object get(string $id)

Gets a container service by its id.

Parameters

string $id The service id

Return Value

object The service

at line 401
protected mixed getParameter(string $name)

Gets a container configuration parameter by its name.

Parameters

string $name The parameter name

Return Value

mixed

at line 414
protected bool isCsrfTokenValid(string $id, string $token)

Checks the validity of a CSRF token.

Parameters

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

Return Value

bool