Controller
Controller
class Controller extends ContainerAware
Controller is a simple implementation of a Controller.
It provides methods to common features needed in controllers.
Methods
setContainer(ContainerInterface $container = null) Sets the container. | from ContainerAware | |
string | generateUrl(string $route, mixed $parameters = array(), bool|string $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH) Generates a URL from the given parameters. | |
Response | forward(string $controller, array $path = array(), array $query = array()) Forwards the request to another controller. | |
RedirectResponse | redirect(string $url, int $status = 302) Returns a RedirectResponse to the given URL. | |
string | renderView(string $view, array $parameters = array()) Returns a rendered view. | |
Response | render(string $view, array $parameters = array(), Response $response = null) Renders a view. | |
StreamedResponse | stream(string $view, array $parameters = array(), StreamedResponse $response = null) Streams a view. | |
NotFoundHttpException | createNotFoundException(string $message = 'Not Found', Exception $previous = null) Returns a NotFoundHttpException. | |
AccessDeniedException | createAccessDeniedException(string $message = 'Access Denied.', Exception $previous = null) Returns an AccessDeniedException. | |
Form | createForm(string|FormTypeInterface $type, mixed $data = null, array $options = array()) Creates and returns a Form instance from the type of the form. | |
FormBuilder | createFormBuilder(mixed $data = null, array $options = array()) Creates and returns a form builder instance. | |
Request | 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. |
Details
setContainer(ContainerInterface $container = null)
Sets the container.
Parameters
ContainerInterface | $container | A ContainerInterface instance or null |
string generateUrl(string $route, mixed $parameters = array(), bool|string $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 |
bool|string | $referenceType | The type of reference (one of the constants in UrlGeneratorInterface) |
Return Value
string | The generated URL |
See also
UrlGeneratorInterface |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Request getRequest() deprecated
deprecated
Shortcut to return the request service.
Return Value
Request |
Registry getDoctrine()
Shortcut to return the Doctrine Registry service.
Return Value
Registry |
Exceptions
LogicException | If DoctrineBundle is not available |
mixed getUser()
Get a user from the Security Token Storage.
Return Value
mixed |
Exceptions
LogicException | If SecurityBundle is not available |
See also
TokenInterface::getUser() |
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 |
object get(string $id)
Gets a container service by its id.
Parameters
string | $id | The service id |
Return Value
object | The service |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Bundle/FrameworkBundle/Controller/Controller.html