From bbc52a1d14358500b39073ba7cb46ed95fbc5810 Mon Sep 17 00:00:00 2001 From: Nicolas Grekas Date: Tue, 3 Oct 2017 11:44:07 +0200 Subject: [PATCH] [FrameworkBundle] Make Controller helpers final --- .../FrameworkBundle/Controller/Controller.php | 24 ------- .../Controller/ControllerTrait.php | 66 +++++++++++++++++++ 2 files changed, 66 insertions(+), 24 deletions(-) diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php b/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php index 870965201e397..11161d46ebd17 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php +++ b/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php @@ -26,30 +26,6 @@ abstract class Controller implements ContainerAwareInterface use ContainerAwareTrait; use ControllerTrait; - /** - * Returns true if the service id is defined. - * - * @param string $id The service id - * - * @return bool true if the service id is defined, false otherwise - */ - protected function has($id) - { - return $this->container->has($id); - } - - /** - * Gets a container service by its id. - * - * @param string $id The service id - * - * @return object The service - */ - protected function get($id) - { - return $this->container->get($id); - } - /** * Gets a container configuration parameter by its name. * diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php index 77a02883083b7..593c02f14522d 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php +++ b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php @@ -39,6 +39,34 @@ */ trait ControllerTrait { + /** + * Returns true if the service id is defined. + * + * @param string $id The service id + * + * @return bool true if the service id is defined, false otherwise + * + * @final since version 3.4 + */ + protected function has($id) + { + return $this->container->has($id); + } + + /** + * Gets a container service by its id. + * + * @param string $id The service id + * + * @return object The service + * + * @final since version 3.4 + */ + protected function get($id) + { + return $this->container->get($id); + } + /** * Generates a URL from the given parameters. * @@ -49,6 +77,8 @@ trait ControllerTrait * @return string The generated URL * * @see UrlGeneratorInterface + * + * @final since version 3.4 */ protected function generateUrl($route, $parameters = array(), $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH) { @@ -63,6 +93,8 @@ protected function generateUrl($route, $parameters = array(), $referenceType = U * @param array $query An array of query parameters * * @return Response A Response instance + * + * @final since version 3.4 */ protected function forward($controller, array $path = array(), array $query = array()) { @@ -81,6 +113,8 @@ protected function forward($controller, array $path = array(), array $query = ar * @param int $status The status code to use for the Response * * @return RedirectResponse + * + * @final since version 3.4 */ protected function redirect($url, $status = 302) { @@ -95,6 +129,8 @@ protected function redirect($url, $status = 302) * @param int $status The status code to use for the Response * * @return RedirectResponse + * + * @final since version 3.4 */ protected function redirectToRoute($route, array $parameters = array(), $status = 302) { @@ -110,6 +146,8 @@ protected function redirectToRoute($route, array $parameters = array(), $status * @param array $context Context to pass to serializer when using serializer component * * @return JsonResponse + * + * @final since version 3.4 */ protected function json($data, $status = 200, $headers = array(), $context = array()) { @@ -132,6 +170,8 @@ protected function json($data, $status = 200, $headers = array(), $context = arr * @param string $disposition Disposition of response ("attachment" is default, other type is "inline") * * @return BinaryFileResponse + * + * @final since version 3.4 */ protected function file($file, $fileName = null, $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT) { @@ -148,6 +188,8 @@ protected function file($file, $fileName = null, $disposition = ResponseHeaderBa * @param string $message The message * * @throws \LogicException + * + * @final since version 3.4 */ protected function addFlash($type, $message) { @@ -167,6 +209,8 @@ protected function addFlash($type, $message) * @return bool * * @throws \LogicException + * + * @final since version 3.4 */ protected function isGranted($attributes, $subject = null) { @@ -186,6 +230,8 @@ protected function isGranted($attributes, $subject = null) * @param string $message The message passed to the exception * * @throws AccessDeniedException + * + * @final since version 3.4 */ protected function denyAccessUnlessGranted($attributes, $subject = null, $message = 'Access Denied.') { @@ -205,6 +251,8 @@ protected function denyAccessUnlessGranted($attributes, $subject = null, $messag * @param array $parameters An array of parameters to pass to the view * * @return string The rendered view + * + * @final since version 3.4 */ protected function renderView($view, array $parameters = array()) { @@ -227,6 +275,8 @@ protected function renderView($view, array $parameters = array()) * @param Response $response A response instance * * @return Response A Response instance + * + * @final since version 3.4 */ protected function render($view, array $parameters = array(), Response $response = null) { @@ -255,6 +305,8 @@ protected function render($view, array $parameters = array(), Response $response * @param StreamedResponse $response A response instance * * @return StreamedResponse A StreamedResponse instance + * + * @final since version 3.4 */ protected function stream($view, array $parameters = array(), StreamedResponse $response = null) { @@ -294,6 +346,8 @@ protected function stream($view, array $parameters = array(), StreamedResponse $ * @param \Exception|null $previous The previous exception * * @return NotFoundHttpException + * + * @final since version 3.4 */ protected function createNotFoundException($message = 'Not Found', \Exception $previous = null) { @@ -311,6 +365,8 @@ protected function createNotFoundException($message = 'Not Found', \Exception $p * @param \Exception|null $previous The previous exception * * @return AccessDeniedException + * + * @final since version 3.4 */ protected function createAccessDeniedException($message = 'Access Denied.', \Exception $previous = null) { @@ -325,6 +381,8 @@ protected function createAccessDeniedException($message = 'Access Denied.', \Exc * @param array $options Options for the form * * @return Form + * + * @final since version 3.4 */ protected function createForm($type, $data = null, array $options = array()) { @@ -338,6 +396,8 @@ protected function createForm($type, $data = null, array $options = array()) * @param array $options Options for the form * * @return FormBuilder + * + * @final since version 3.4 */ protected function createFormBuilder($data = null, array $options = array()) { @@ -350,6 +410,8 @@ protected function createFormBuilder($data = null, array $options = array()) * @return Registry * * @throws \LogicException If DoctrineBundle is not available + * + * @final since version 3.4 */ protected function getDoctrine() { @@ -368,6 +430,8 @@ protected function getDoctrine() * @throws \LogicException If SecurityBundle is not available * * @see TokenInterface::getUser() + * + * @final since version 3.4 */ protected function getUser() { @@ -394,6 +458,8 @@ protected function getUser() * @param string $token The actual token sent with the request that should be validated * * @return bool + * + * @final since version 3.4 */ protected function isCsrfTokenValid($id, $token) { pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy