1. class
  2. RZ
  3. \
  4. Roadiz
  5. \
  6. CMS
  7. \
  8. Controllers
  9. \
  10. Controller

Controller

abstract class Controller implements ContainerAwareInterface (View source)

Base controller.

Properties

protected Container|null $container

Methods

Request
getRequest()

Shortcut to return the request service.

ContainerAwareInterface
setContainer(Container $container)

Sets the Container associated with this Controller.

Container
getContainer()

No description

mixed
getService(string|null $key = null) deprecated

Get mixed object from Dependency Injection container.

mixed
get(string $serviceName)

Return a service from container.

bool
has(string $serviceName)

Returns true if the service is defined.

AuthorizationChecker
getAuthorizationChecker()

Alias for $this->container['securityAuthorizationChecker'].

TokenStorageInterface
getTokenStorage()

Alias for $this->container['securityTokenStorage'].

EntityManager
em()

Alias for $this->container['em'].

Translator
getTranslator()

No description

Twig_Environment
getTwig()

No description

string
generateUrl(string|NodesSources $route, mixed $parameters = [], int $referenceType = Router::ABSOLUTE_PATH)

Wrap $this->container['urlGenerator']->generate

RedirectResponse
redirect(string $url, integer $status = Response::HTTP_FOUND)

Returns a RedirectResponse to the given URL.

static string
getCalledClass()

No description

validateAccessForRole(string $role)

Validate a request against a given ROLE_* and throws an AccessDeniedException exception.

RedirectResponse
removeTrailingSlashAction(Request $request)

Custom route for redirecting routes with a trailing slash.

Translation
bindLocaleFromRoute(Request $request, string $_locale = null)

Make translation variable with the good localization.

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

Returns a rendered view.

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

Return a Response from a template string with its rendering assignation.

string
getNamespacedView(string $view, string $namespace = '')

No description

JsonResponse
renderJson(array $data = [], int $httpStatus = JsonResponse::HTTP_OK)

No description

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

Forwards the request to another controller.

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

Returns a ResourceNotFoundException.

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

Returns an AccessDeniedException.

Form
createForm(string|FormTypeInterface $type, mixed $data = null, array $options = [])

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

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

Creates and returns a form builder instance.

FormBuilderInterface
createNamedFormBuilder($name = 'form', $data = null, array $options = [])

Creates and returns a form builder instance.

EntityListManager
createEntityListManager(mixed $entity, array $criteria = [], array $ordering = [])

Creates and returns an EntityListManager instance.

ContactFormManager
createContactFormManager()

Create and return a ContactFormManager to build and send contact form by email.

EmailManager
createEmailManager()

Create and return a EmailManager to build and send emails.

User|null
getUser()

Get a user from the tokenStorage.

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.

Details

at line 74
Request getRequest()

Shortcut to return the request service.

Return Value

Request

at line 85
ContainerAwareInterface setContainer(Container $container)

Sets the Container associated with this Controller.

Parameters

Container $container

Return Value

ContainerAwareInterface

at line 94
Container getContainer()

Return Value

Container

at line 108
mixed getService(string|null $key = null) deprecated

deprecated Use Controller::get to better match Symfony style.

Get mixed object from Dependency Injection container.

Alias for $this->container[$key]

Parameters

string|null $key

Return Value

mixed

at line 116
mixed get(string $serviceName)

Return a service from container.

Parameters

string $serviceName

Return Value

mixed

at line 124
bool has(string $serviceName)

Returns true if the service is defined.

Parameters

string $serviceName

Return Value

bool true if the service is defined, false otherwise

at line 134
AuthorizationChecker getAuthorizationChecker()

Alias for $this->container['securityAuthorizationChecker'].

Return Value

AuthorizationChecker

at line 144
TokenStorageInterface getTokenStorage()

Alias for $this->container['securityTokenStorage'].

Return Value

TokenStorageInterface

at line 154
EntityManager em()

Alias for $this->container['em'].

Return Value

EntityManager

at line 162
Translator getTranslator()

Return Value

Translator

at line 170
Twig_Environment getTwig()

Return Value

Twig_Environment

at line 184
string generateUrl(string|NodesSources $route, mixed $parameters = [], int $referenceType = Router::ABSOLUTE_PATH)

Wrap $this->container['urlGenerator']->generate

Parameters

string|NodesSources $route
mixed $parameters
int $referenceType

Return Value

string

at line 197
RedirectResponse redirect(string $url, integer $status = Response::HTTP_FOUND)

Returns a RedirectResponse to the given URL.

Parameters

string $url
integer $status

Return Value

RedirectResponse

at line 205
static string getCalledClass()

Return Value

string

at line 222
validateAccessForRole(string $role)

Validate a request against a given ROLE_* and throws an AccessDeniedException exception.

Parameters

string $role

Exceptions

AccessDeniedException

at line 236
RedirectResponse removeTrailingSlashAction(Request $request)

Custom route for redirecting routes with a trailing slash.

Parameters

Request $request

Return Value

RedirectResponse

at line 255
protected Translation bindLocaleFromRoute(Request $request, string $_locale = null)

Make translation variable with the good localization.

Parameters

Request $request
string $_locale

Return Value

Translation

Exceptions

NoTranslationAvailableException

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

Returns a rendered view.

Parameters

string $view
array $parameters

Return Value

string

at line 313
Response render(string $view, array $parameters = [], Response $response = null, string $namespace = "")

Return a Response from a template string with its rendering assignation.

Parameters

string $view Template file path
array $parameters Twig assignation array
Response $response Optional Response object to customize response parameters
string $namespace Twig loader namespace

Return Value

Response

Exceptions

Twig_Error_Runtime

See also

http://api.symfony.com/2.6/Symfony/Bundle/FrameworkBundle/Controller/Controller.html#method_render

at line 344
protected string getNamespacedView(string $view, string $namespace = '')

Parameters

string $view
string $namespace

Return Value

string

at line 358
JsonResponse renderJson(array $data = [], int $httpStatus = JsonResponse::HTTP_OK)

Parameters

array $data
int $httpStatus

Return Value

JsonResponse

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

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 391
protected ResourceNotFoundException createNotFoundException(string $message = 'Not Found', Exception $previous = null)

Returns a ResourceNotFoundException.

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

ResourceNotFoundException

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

Return Value

AccessDeniedException

at line 420
protected Form createForm(string|FormTypeInterface $type, mixed $data = null, array $options = [])

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 433
protected FormBuilderInterface createFormBuilder(mixed $data = null, array $options = [])

Creates and returns a form builder instance.

Parameters

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

Return Value

FormBuilderInterface

at line 446
protected FormBuilderInterface createNamedFormBuilder($name = 'form', $data = null, array $options = [])

Creates and returns a form builder instance.

Parameters

$name
$data
array $options

Return Value

FormBuilderInterface

at line 463
EntityListManager createEntityListManager(mixed $entity, array $criteria = [], array $ordering = [])

Creates and returns an EntityListManager instance.

Parameters

mixed $entity Entity class path
array $criteria
array $ordering

Return Value

EntityListManager

at line 480
ContactFormManager createContactFormManager()

Create and return a ContactFormManager to build and send contact form by email.

Return Value

ContactFormManager

at line 490
EmailManager createEmailManager()

Create and return a EmailManager to build and send emails.

Return Value

EmailManager

at line 504
protected User|null getUser()

Get a user from the tokenStorage.

Return Value

User|null

Exceptions

LogicException If tokenStorage is not available

See also

TokenInterface::getUser()

at line 530
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 549
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