Adds deprecation notices for structures to be removed in 3.0.

Hugo Hamon · Hugo Hamon · commit f2f8e75be059 · 2015-01-05T15:57:15.000+01:00
diff --git a/Debug/ErrorHandler.php b/Debug/ErrorHandler.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\HttpKernel\Debug;
 
-trigger_error('Symfony\Component\HttpKernel\Debug\ErrorHandler is deprecated since version 2.3 and will be removed in 3.0. Use the same class from the Debug component instead.', E_USER_DEPRECATED);
+trigger_error('The '.__NAMESPACE__.'\ErrorHandler class is deprecated since version 2.3 and will be removed in 3.0. Use the Symfony\Component\Debug\ErrorHandler class instead.', E_USER_DEPRECATED);
 
 use Symfony\Component\Debug\ErrorHandler as DebugErrorHandler;
 
diff --git a/Debug/ExceptionHandler.php b/Debug/ExceptionHandler.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\HttpKernel\Debug;
 
-trigger_error('Symfony\Component\HttpKernel\Debug\ExceptionHandler is deprecated since version 2.3 and will be removed in 3.0. Use the same class from the Debug component instead.', E_USER_DEPRECATED);
+trigger_error('The '.__NAMESPACE__.'\ExceptionHandler class is deprecated since version 2.3 and will be removed in 3.0. Use the Symfony\Component\Debug\ExceptionHandler class instead.', E_USER_DEPRECATED);
 
 use Symfony\Component\Debug\ExceptionHandler as DebugExceptionHandler;
 
diff --git a/Debug/TraceableEventDispatcher.php b/Debug/TraceableEventDispatcher.php
@@ -38,6 +38,7 @@ class TraceableEventDispatcher extends BaseTraceableEventDispatcher
      */
     public function setProfiler(Profiler $profiler = null)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
     }
 
     /**
diff --git a/DependencyInjection/RegisterListenersPass.php b/DependencyInjection/RegisterListenersPass.php
@@ -11,14 +11,14 @@
 
 namespace Symfony\Component\HttpKernel\DependencyInjection;
 
-trigger_error('Class "Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass" is deprecated since 2.5 and will be removed in 3.0. Use "Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass" instead.', E_USER_DEPRECATED);
+trigger_error('The '.__NAMESPACE__.'\RegisterListenersPass is deprecated since version 2.5 and will be removed in 3.0. Use the Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass class instead.', E_USER_DEPRECATED);
 
 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass as BaseRegisterListenersPass;
 
 /**
  * Compiler pass to register tagged services for an event dispatcher.
  *
- * @deprecated Deprecated in 2.5, to be removed in 3.0. Use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass instead.
+ * @deprecated since version 2.5, to be removed in 3.0. Use the Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass class instead.
  */
 class RegisterListenersPass extends BaseRegisterListenersPass
 {
diff --git a/EventListener/ErrorsLoggerListener.php b/EventListener/ErrorsLoggerListener.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\HttpKernel\EventListener;
 
+trigger_error('The '.__NAMESPACE__.'\ErrorsLoggerListener class is deprecated since version 2.6 and will be removed in 3.0. Use the Symfony\Component\HttpKernel\EventListener\DebugHandlersListener class instead.', E_USER_DEPRECATED);
+
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Debug\ErrorHandler;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -22,12 +24,11 @@
  * @author Colin Frei <colin@colinfrei.com>
  * @author Konstantin Myakshin <koc-dp@yandex.ru>
  *
- * @deprecated since 2.6, to be removed in 3.0. Use DebugHandlersListener instead.
+ * @deprecated since version 2.6, to be removed in 3.0. Use the DebugHandlersListener class instead.
  */
 class ErrorsLoggerListener implements EventSubscriberInterface
 {
     private $channel;
-
     private $logger;
 
     public function __construct($channel, LoggerInterface $logger = null)
diff --git a/EventListener/EsiListener.php b/EventListener/EsiListener.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\HttpKernel\EventListener;
 
+trigger_error('The '.__NAMESPACE__.'\EsiListener class is deprecated since version 2.6 and will be removed in 3.0. Use the Symfony\Component\HttpKernel\EventListener\SurrogateListener class instead.', E_USER_DEPRECATED);
+
 /**
  * EsiListener adds a Surrogate-Control HTTP header when the Response needs to be parsed for ESI.
  *
diff --git a/EventListener/FragmentListener.php b/EventListener/FragmentListener.php
@@ -88,12 +88,14 @@ protected function validateRequest(Request $request)
     }
 
     /**
-     * @deprecated Deprecated since 2.3.19, to be removed in 3.0.
+     * @deprecated since version 2.3.19, to be removed in 3.0.
      *
      * @return string[]
      */
     protected function getLocalIpAddresses()
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.3.19 and will be removed in 3.0.', E_USER_DEPRECATED);
+
         return array('127.0.0.1', 'fe80::1', '::1');
     }
 
diff --git a/EventListener/LocaleListener.php b/EventListener/LocaleListener.php
@@ -58,6 +58,8 @@ public function __construct($defaultLocale = 'en', RequestContextAwareInterface
      */
     public function setRequest(Request $request = null)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
+
         if (null === $request) {
             return;
         }
diff --git a/EventListener/ProfilerListener.php b/EventListener/ProfilerListener.php
@@ -77,6 +77,8 @@ public function onKernelException(GetResponseForExceptionEvent $event)
      */
     public function onKernelRequest(GetResponseEvent $event)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
+
         if (null === $this->requestStack) {
             $this->requests[] = $event->getRequest();
         }
diff --git a/EventListener/RouterListener.php b/EventListener/RouterListener.php
@@ -86,6 +86,8 @@ public function __construct($matcher, RequestContext $context = null, LoggerInte
      */
     public function setRequest(Request $request = null)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be made private in 3.0.', E_USER_DEPRECATED);
+
         if (null !== $request && $this->request !== $request) {
             $this->context->fromRequest($request);
         }
diff --git a/Exception/FatalErrorException.php b/Exception/FatalErrorException.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\HttpKernel\Exception;
 
-trigger_error('Symfony\Component\HttpKernel\Exception\FatalErrorException is deprecated since version 2.3 and will be removed in 3.0. Use the same class from the Debug component instead.', E_USER_DEPRECATED);
+trigger_error('The '.__NAMESPACE__.'\FatalErrorException class is deprecated since version 2.3 and will be removed in 3.0. Use the Symfony\Component\Debug\Exception\FatalErrorException class instead.', E_USER_DEPRECATED);
 
 /**
  * Fatal Error Exception.
diff --git a/Exception/FlattenException.php b/Exception/FlattenException.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\HttpKernel\Exception;
 
-trigger_error('Symfony\Component\HttpKernel\Exception\FlattenException is deprecated since version 2.3 and will be removed in 3.0. Use the same class from the Debug component instead.', E_USER_DEPRECATED);
+trigger_error('The '.__NAMESPACE__.'\FlattenException class is deprecated since version 2.3 and will be removed in 3.0. Use the Symfony\Component\Debug\Exception\FlattenException class instead.', E_USER_DEPRECATED);
 
 /**
  * FlattenException wraps a PHP Exception to be able to serialize it.
diff --git a/Fragment/FragmentHandler.php b/Fragment/FragmentHandler.php
@@ -80,6 +80,8 @@ public function addRenderer(FragmentRendererInterface $renderer)
      */
     public function setRequest(Request $request = null)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
+
         $this->request = $request;
     }
 
diff --git a/HttpCache/Esi.php b/HttpCache/Esi.php
@@ -79,6 +79,8 @@ public function hasSurrogateCapability(Request $request)
      */
     public function hasSurrogateEsiCapability(Request $request)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the hasSurrogateCapability() method instead.', E_USER_DEPRECATED);
+
         if (null === $value = $request->headers->get('Surrogate-Capability')) {
             return false;
         }
@@ -105,6 +107,8 @@ public function addSurrogateCapability(Request $request)
      */
     public function addSurrogateEsiCapability(Request $request)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the addSurrogateCapability() method instead.', E_USER_DEPRECATED);
+
         $current = $request->headers->get('Surrogate-Capability');
         $new = 'symfony2="ESI/1.0"';
 
@@ -148,6 +152,8 @@ public function needsParsing(Response $response)
      */
     public function needsEsiParsing(Response $response)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the needsParsing() method instead.', E_USER_DEPRECATED);
+
         if (!$control = $response->headers->get('Surrogate-Control')) {
             return false;
         }
diff --git a/HttpCache/EsiResponseCacheStrategy.php b/HttpCache/EsiResponseCacheStrategy.php
@@ -15,6 +15,8 @@
 
 namespace Symfony\Component\HttpKernel\HttpCache;
 
+trigger_error('The '.__NAMESPACE__.'\EsiResponseCacheStrategy class is deprecated since version 2.6 and will be removed in 3.0. Use the Symfony\Component\HttpKernel\HttpCache\ResponseCacheStrategy class instead.', E_USER_DEPRECATED);
+
 /**
  * EsiResponseCacheStrategy knows how to compute the Response cache HTTP header
  * based on the different ESI response cache headers.
diff --git a/HttpCache/EsiResponseCacheStrategyInterface.php b/HttpCache/EsiResponseCacheStrategyInterface.php
@@ -15,6 +15,8 @@
 
 namespace Symfony\Component\HttpKernel\HttpCache;
 
+trigger_error('The '.__NAMESPACE__.'\EsiResponseCacheStrategyInterface interface is deprecated since version 2.6 and will be removed in 3.0. Use the Symfony\Component\HttpKernel\HttpCache\ResponseCacheStrategyInterface interface instead.', E_USER_DEPRECATED);
+
 /**
  * ResponseCacheStrategyInterface implementations know how to compute the
  * Response cache HTTP header based on the different response cache headers.
diff --git a/HttpCache/HttpCache.php b/HttpCache/HttpCache.php
@@ -174,6 +174,8 @@ public function getSurrogate()
      */
     public function getEsi()
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the getSurrogate() method instead.', E_USER_DEPRECATED);
+
         if (!$this->surrogate instanceof Esi) {
             throw new \LogicException('This instance of HttpCache was not set up to use ESI as surrogate handler. You must overwrite and use createSurrogate');
         }
diff --git a/Kernel.php b/Kernel.php
@@ -89,7 +89,7 @@ public function __construct($environment, $debug)
         $defClass = $defClass->getDeclaringClass()->name;
 
         if (__CLASS__ !== $defClass) {
-            trigger_error(sprintf('Calling %s::init() was deprecated in Symfony 2.3 and will be removed in 3.0. Move your logic to the constructor instead.', $defClass), E_USER_DEPRECATED);
+            trigger_error(sprintf('Calling the %s::init() method is deprecated since version 2.3 and will be removed in 3.0. Move your logic to the constructor method instead.', $defClass), E_USER_DEPRECATED);
             $this->init();
         }
     }
@@ -99,6 +99,7 @@ public function __construct($environment, $debug)
      */
     public function init()
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Move your logic to the constructor method instead.', E_USER_DEPRECATED);
     }
 
     public function __clone()
@@ -220,7 +221,7 @@ public function getBundles()
      */
     public function isClassInActiveBundle($class)
     {
-        trigger_error('Symfony\\Component\\HttpKernel\\Kernel::isClassInActiveBundle() is deprecated since version 2.6 and will be removed in version 3.0.', E_USER_DEPRECATED);
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in version 3.0.', E_USER_DEPRECATED);
 
         foreach ($this->getBundles() as $bundle) {
             if (0 === strpos($class, $bundle->getNamespace())) {
diff --git a/Log/LoggerInterface.php b/Log/LoggerInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\HttpKernel\Log;
 
+trigger_error('The '.__NAMESPACE__.'\LoggerInterface interface is deprecated since version 2.2 and will be removed in 3.0. Type-hint with the \Psr\Log\LoggerInterface interface instead.', E_USER_DEPRECATED);
+
 use Psr\Log\LoggerInterface as PsrLogger;
 
 /**
@@ -27,28 +29,28 @@ interface LoggerInterface extends PsrLogger
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use emergency() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use emergency() which is PSR-3 compatible.
      */
     public function emerg($message, array $context = array());
 
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use critical() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use critical() which is PSR-3 compatible.
      */
     public function crit($message, array $context = array());
 
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use error() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use error() which is PSR-3 compatible.
      */
     public function err($message, array $context = array());
 
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use warning() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use warning() which is PSR-3 compatible.
      */
     public function warn($message, array $context = array());
 }
diff --git a/Log/NullLogger.php b/Log/NullLogger.php
@@ -25,40 +25,40 @@ class NullLogger extends PsrNullLogger implements LoggerInterface
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use emergency() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use emergency() which is PSR-3 compatible.
      */
     public function emerg($message, array $context = array())
     {
-        trigger_error('The emerg() method of the NullLogger was removed. You should use the new method emergency() instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.2 and will be removed in 3.0. You should use the new emergency() method instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
     }
 
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use critical() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use critical() which is PSR-3 compatible.
      */
     public function crit($message, array $context = array())
     {
-        trigger_error('The crit() method of the NullLogger was removed. You should use the new method critical() instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.2 and will be removed in 3.0. You should use the new critical() method instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
     }
 
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use error() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use error() which is PSR-3 compatible.
      */
     public function err($message, array $context = array())
     {
-        trigger_error('The err() method of the NullLogger was removed. You should use the new method error() instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.2 and will be removed in 3.0. You should use the new error() method instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
     }
 
     /**
      * @api
      *
-     * @deprecated since 2.2, to be removed in 3.0. Use warning() which is PSR-3 compatible.
+     * @deprecated since version 2.2, to be removed in 3.0. Use warning() which is PSR-3 compatible.
      */
     public function warn($message, array $context = array())
     {
-        trigger_error('The warn() method of the NullLogger was removed. You should use the new method warning() instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.2 and will be removed in 3.0. You should use the new warning() method instead, which is PSR-3 compatible.', E_USER_DEPRECATED);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ class TraceableEventDispatcher extends BaseTraceableEventDispatcher`
`38`	`38`	`*/`
`39`	`39`	`public function setProfiler(Profiler $profiler = null)`
`40`	`40`	`{`
	`41`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,14 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\HttpKernel\DependencyInjection;`
`13`	`13`
`14`		`-trigger_error('Class "Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass" is deprecated since 2.5 and will be removed in 3.0. Use "Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass" instead.', E_USER_DEPRECATED);`
	`14`	`+trigger_error('The '.__NAMESPACE__.'\RegisterListenersPass is deprecated since version 2.5 and will be removed in 3.0. Use the Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass class instead.', E_USER_DEPRECATED);`
`15`	`15`
`16`	`16`	`use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass as BaseRegisterListenersPass;`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* Compiler pass to register tagged services for an event dispatcher.`
`20`	`20`	`*`
`21`		`- * @deprecated Deprecated in 2.5, to be removed in 3.0. Use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass instead.`
	`21`	`+ * @deprecated since version 2.5, to be removed in 3.0. Use the Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass class instead.`
`22`	`22`	`*/`
`23`	`23`	`class RegisterListenersPass extends BaseRegisterListenersPass`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\HttpKernel\EventListener;`
`13`	`13`
	`14`	`+trigger_error('The '.__NAMESPACE__.'\EsiListener class is deprecated since version 2.6 and will be removed in 3.0. Use the Symfony\Component\HttpKernel\EventListener\SurrogateListener class instead.', E_USER_DEPRECATED);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* EsiListener adds a Surrogate-Control HTTP header when the Response needs to be parsed for ESI.`
`16`	`18`	`*`
Original file line number	Diff line number	Diff line change
`@@ -88,12 +88,14 @@ protected function validateRequest(Request $request)`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`/**`
`91`		`- * @deprecated Deprecated since 2.3.19, to be removed in 3.0.`
	`91`	`+ * @deprecated since version 2.3.19, to be removed in 3.0.`
`92`	`92`	`*`
`93`	`93`	`* @return string[]`
`94`	`94`	`*/`
`95`	`95`	`protected function getLocalIpAddresses()`
`96`	`96`	`{`
	`97`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.3.19 and will be removed in 3.0.', E_USER_DEPRECATED);`
	`98`	`+`
`97`	`99`	`return array('127.0.0.1', 'fe80::1', '::1');`
`98`	`100`	`}`
`99`	`101`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,8 @@ public function __construct($defaultLocale = 'en', RequestContextAwareInterface`
`58`	`58`	`*/`
`59`	`59`	`public function setRequest(Request $request = null)`
`60`	`60`	`{`
	`61`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);`
	`62`	`+`
`61`	`63`	`if (null === $request) {`
`62`	`64`	`return;`
`63`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,8 @@ public function onKernelException(GetResponseForExceptionEvent $event)`
`77`	`77`	`*/`
`78`	`78`	`public function onKernelRequest(GetResponseEvent $event)`
`79`	`79`	`{`
	`80`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);`
	`81`	`+`
`80`	`82`	`if (null === $this->requestStack) {`
`81`	`83`	`$this->requests[] = $event->getRequest();`
`82`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,8 @@ public function __construct($matcher, RequestContext $context = null, LoggerInte`
`86`	`86`	`*/`
`87`	`87`	`public function setRequest(Request $request = null)`
`88`	`88`	`{`
	`89`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be made private in 3.0.', E_USER_DEPRECATED);`
	`90`	`+`
`89`	`91`	`if (null !== $request && $this->request !== $request) {`
`90`	`92`	`$this->context->fromRequest($request);`
`91`	`93`	`}`