Normalizes deprecation notice messages.

Hugo Hamon · Hugo Hamon · commit 2a3e7d2cc9cc · 2015-01-05T16:02:28.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/RequestHelper.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/RequestHelper.php
@@ -30,7 +30,7 @@ class RequestHelper extends Helper
      *
      * @param Request|RequestStack $requestStack A RequestStack instance or a Request instance
      *
-     * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0
+     * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0.
      */
     public function __construct($requestStack)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/SessionHelper.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/SessionHelper.php
@@ -30,7 +30,7 @@ class SessionHelper extends Helper
      *
      * @param Request|RequestStack $requestStack A RequestStack instance or a Request instance
      *
-     * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0
+     * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0.
      */
     public function __construct($requestStack)
     {
diff --git a/src/Symfony/Bundle/TwigBundle/TwigEngine.php b/src/Symfony/Bundle/TwigBundle/TwigEngine.php
@@ -42,16 +42,17 @@ public function __construct(\Twig_Environment $environment, TemplateNameParserIn
     }
 
     /**
-     * @deprecated Deprecated since version 2.3, to be removed in 3.0. Inject the escaping
-     *             strategy on Twig_Environment instead
+     * @deprecated since version 2.3, to be removed in 3.0.
+     *             Inject the escaping strategy on \Twig_Environment instead.
      */
     public function setDefaultEscapingStrategy($strategy)
     {
         $this->environment->getExtension('escaper')->setDefaultStrategy($strategy);
     }
 
     /**
-     * @deprecated Deprecated since version 2.3, to be removed in 3.0. Use TwigDefaultEscapingStrategy instead.
+     * @deprecated since version 2.3, to be removed in 3.0.
+     *             Use TwigDefaultEscapingStrategy instead.
      */
     public function guessDefaultEscapingStrategy($filename)
     {
diff --git a/src/Symfony/Component/ClassLoader/ApcUniversalClassLoader.php b/src/Symfony/Component/ClassLoader/ApcUniversalClassLoader.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\ClassLoader;
 
+trigger_error('The '.__NAMESPACE__.'\ApcUniversalClassLoader class is deprecated since version 2.7 and will be removed in 3.0. Use the Symfony\Component\ClassLoader\ApcClassLoader class instead.', E_USER_DEPRECATED);
+
 /**
  * ApcUniversalClassLoader implements a "universal" autoloader cached in APC for PHP 5.3.
  *
@@ -60,7 +62,8 @@
  *
  * @api
  *
- * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the ApcClassLoader class instead.
+ * @deprecated since version 2.4, to be removed in 3.0.
+ *             Use the {@link ClassLoader} class instead.
  */
 class ApcUniversalClassLoader extends UniversalClassLoader
 {
diff --git a/src/Symfony/Component/ClassLoader/CHANGELOG.md b/src/Symfony/Component/ClassLoader/CHANGELOG.md
@@ -1,11 +1,6 @@
 CHANGELOG
 =========
 
-2.7.0
------
-
- * The UniversalClassLoader class has been deprecated in favor of ClassLoader class
-
 2.4.0
 -----
 
diff --git a/src/Symfony/Component/ClassLoader/DebugUniversalClassLoader.php b/src/Symfony/Component/ClassLoader/DebugUniversalClassLoader.php
@@ -11,12 +11,15 @@
 
 namespace Symfony\Component\ClassLoader;
 
+trigger_error('The '.__NAMESPACE__.'\DebugUniversalClassLoader class is deprecated since version 2.4 and will be removed in 3.0. Use the Symfony\Component\Debug\DebugClassLoader class instead.', E_USER_DEPRECATED);
+
 /**
  * Checks that the class is actually declared in the included file.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  *
- * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the DebugClassLoader provided by the Debug component instead.
+ * @deprecated since version 2.4, to be removed in 3.0.
+ *             Use the {@link \Symfony\Component\Debug\DebugClassLoader} class instead.
  */
 class DebugUniversalClassLoader extends UniversalClassLoader
 {
diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php
@@ -101,7 +101,7 @@ private function getClassCandidates($class)
             if ($function[0] instanceof DebugClassLoader) {
                 $function = $function[0]->getClassLoader();
 
-                // Since 2.5, returning an object from DebugClassLoader::getClassLoader() is @deprecated
+                // @deprecated since version 2.5. Returning an object from DebugClassLoader::getClassLoader() is deprecated.
                 if (is_object($function)) {
                     $function = array($function);
                 }
diff --git a/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php b/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php
@@ -169,7 +169,7 @@ public function clear()
     /**
      * Returns an iterator for flashes.
      *
-     * @deprecated Will be removed in 3.0.
+     * @deprecated since version 2.4, to be removed in 3.0.
      *
      * @return \ArrayIterator An \ArrayIterator instance
      */
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/LegacyPdoSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/LegacyPdoSessionHandler.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;
 
+trigger_error('The '.__NAMESPACE__.'\LegacyPdoSessionHandler class is deprecated since version 2.6 and will be removed in 3.0. Use the Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler class instead.', E_USER_DEPRECATED);
+
 /**
  * Session handler using a PDO connection to read and write data.
  *
@@ -77,8 +79,6 @@ public function __construct(\PDO $pdo, array $dbOptions = array())
             throw new \InvalidArgumentException(sprintf('"%s" requires PDO error mode attribute be set to throw Exceptions (i.e. $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION))', __CLASS__));
         }
 
-        trigger_error('"Symfony\Component\HttpFoundation\Session\Storage\Handler\LegacyPdoSessionHandler" is deprecated since version 2.6 and will be removed in 3.0. Use "Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler" instead.', E_USER_DEPRECATED);
-
         $this->pdo = $pdo;
         $dbOptions = array_merge(array(
             'db_id_col' => 'sess_id',
diff --git a/src/Symfony/Component/HttpKernel/EventListener/ExceptionListener.php b/src/Symfony/Component/HttpKernel/EventListener/ExceptionListener.php
@@ -116,7 +116,7 @@ protected function duplicateRequest(\Exception $exception, Request $request)
             'logger' => $this->logger instanceof DebugLoggerInterface ? $this->logger : null,
             // keep for BC -- as $format can be an argument of the controller callable
             // see src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php
-            // @deprecated in 2.4, to be removed in 3.0
+            // @deprecated since version 2.4, to be removed in 3.0
             'format' => $request->getRequestFormat(),
         );
         $request = $request->duplicate(null, null, $attributes);
diff --git a/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php b/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php
@@ -86,7 +86,7 @@ public function __construct($matcher, RequestContext $context = null, LoggerInte
      *
      * @param Request|null $request A Request instance
      *
-     * @deprecated since version 2.4, to be moved to a private function in 3.0.
+     * @deprecated since version 2.4, to be removed in 3.0.
      */
     public function setRequest(Request $request = null)
     {
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonDecode.php b/src/Symfony/Component/Serializer/Encoder/JsonDecode.php
@@ -55,7 +55,8 @@ public function __construct($associative = false, $depth = 512)
      *
      * @return int
      *
-     * @deprecated since version 2.5, decode() throws an exception if error found, will be removed in 3.0
+     * @deprecated since version 2.5, to be removed in 3.0.
+     *             The {@self decode()} method throws an exception if error found.
      *
      * @see http://php.net/manual/en/function.json-last-error.php json_last_error
      */
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonEncode.php b/src/Symfony/Component/Serializer/Encoder/JsonEncode.php
@@ -33,7 +33,8 @@ public function __construct($bitmask = 0)
      *
      * @return int
      *
-     * @deprecated since version 2.5, encode() throws an exception if error found, will be removed in 3.0
+     * @deprecated since version 2.5, to be removed in 3.0.
+     *             The {@self encode()} throws an exception if error found.
      *
      * @see http://php.net/manual/en/function.json-last-error.php json_last_error
      */
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonEncoder.php b/src/Symfony/Component/Serializer/Encoder/JsonEncoder.php
@@ -41,7 +41,7 @@ public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodin
      *
      * @return int
      *
-     * @deprecated since version 2.5, JsonEncode throws exception if an error is found, will be removed in 3.0
+     * @deprecated since version 2.5, to be removed in 3.0. JsonEncode throws exception if an error is found.
      */
     public function getLastEncodingError()
     {
@@ -55,7 +55,7 @@ public function getLastEncodingError()
      *
      * @return int
      *
-     * @deprecated since version 2.5, JsonDecode throws exception if an error is found, will be removed in 3.0
+     * @deprecated since version 2.5, to be removed in 3.0. JsonDecode throws exception if an error is found.
      */
     public function getLastDecodingError()
     {
diff --git a/src/Symfony/Component/Validator/Constraints/GroupSequence.php b/src/Symfony/Component/Validator/Constraints/GroupSequence.php
@@ -103,7 +103,7 @@ public function __construct(array $groups)
      *
      * @see \IteratorAggregate::getIterator()
      *
-     * @deprecated since version 2.5, to be removed in Symfony 3.0.
+     * @deprecated since version 2.5, to be removed in 3.0.
      */
     public function getIterator()
     {
@@ -121,7 +121,7 @@ public function getIterator()
      *
      * @return bool Whether the offset exists
      *
-     * @deprecated since version 2.5, to be removed in Symfony 3.0.
+     * @deprecated since version 2.5, to be removed in 3.0.
      */
     public function offsetExists($offset)
     {
@@ -141,7 +141,7 @@ public function offsetExists($offset)
      *
      * @throws OutOfBoundsException If the object does not exist
      *
-     * @deprecated since version 2.5, to be removed in Symfony 3.0.
+     * @deprecated since version 2.5, to be removed in 3.0.
      */
     public function offsetGet($offset)
     {
@@ -165,7 +165,7 @@ public function offsetGet($offset)
      * @param int    $offset The offset
      * @param string $value  The group name
      *
-     * @deprecated since version 2.5, to be removed in Symfony 3.0.
+     * @deprecated since version 2.5, to be removed in 3.0.
      */
     public function offsetSet($offset, $value)
     {
@@ -187,7 +187,7 @@ public function offsetSet($offset, $value)
      *
      * @param int $offset The offset
      *
-     * @deprecated since version 2.5, to be removed in Symfony 3.0.
+     * @deprecated since version 2.5, to be removed in 3.0.
      */
     public function offsetUnset($offset)
     {
@@ -203,7 +203,7 @@ public function offsetUnset($offset)
      *
      * @return int The number of groups
      *
-     * @deprecated since version 2.5, to be removed in Symfony 3.0.
+     * @deprecated since version 2.5, to be removed in 3.0.
      */
     public function count()
     {
diff --git a/src/Symfony/Component/Validator/Context/LegacyExecutionContextFactory.php b/src/Symfony/Component/Validator/Context/LegacyExecutionContextFactory.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\Validator\Context;
 
-trigger_error('The '.__NAMESPACE__.'\LegacyExecutionContextFactory is deprecated since version 2.5 and will be removed in 3.0.');
+trigger_error('The '.__NAMESPACE__.'\LegacyExecutionContextFactory is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
 
 use Symfony\Component\Translation\TranslatorInterface;
 use Symfony\Component\Validator\MetadataFactoryInterface;
diff --git a/src/Symfony/Component/Validator/ExecutionContext.php b/src/Symfony/Component/Validator/ExecutionContext.php
@@ -23,7 +23,7 @@
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
- * @deprecated since version 2.5, to be removed in Symfony 3.0.
+ * @deprecated since version 2.5, to be removed in 3.0.
  *             Use {@link Context\ExecutionContext} instead.
  */
 class ExecutionContext implements ExecutionContextInterface
diff --git a/src/Symfony/Component/Validator/Mapping/ClassMetadata.php b/src/Symfony/Component/Validator/Mapping/ClassMetadata.php
@@ -373,7 +373,7 @@ public function mergeConstraints(ClassMetadata $source)
      *
      * @param MemberMetadata $metadata
      *
-     * @deprecated since version 2.6, to be in 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     protected function addMemberMetadata(MemberMetadata $metadata)
     {

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class RequestHelper extends Helper`
`30`	`30`	`*`
`31`	`31`	`* @param Request\|RequestStack $requestStack A RequestStack instance or a Request instance`
`32`	`32`	`*`
`33`		`- * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0`
	`33`	`+ * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0.`
`34`	`34`	`*/`
`35`	`35`	`public function __construct($requestStack)`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class SessionHelper extends Helper`
`30`	`30`	`*`
`31`	`31`	`* @param Request\|RequestStack $requestStack A RequestStack instance or a Request instance`
`32`	`32`	`*`
`33`		`- * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0`
	`33`	`+ * @deprecated since version 2.5, passing a Request instance is deprecated and support for it will be removed in 3.0.`
`34`	`34`	`*/`
`35`	`35`	`public function __construct($requestStack)`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -42,16 +42,17 @@ public function __construct(\Twig_Environment $environment, TemplateNameParserIn`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * @deprecated Deprecated since version 2.3, to be removed in 3.0. Inject the escaping`
`46`		`- * strategy on Twig_Environment instead`
	`45`	`+ * @deprecated since version 2.3, to be removed in 3.0.`
	`46`	`+ * Inject the escaping strategy on \Twig_Environment instead.`
`47`	`47`	`*/`
`48`	`48`	`public function setDefaultEscapingStrategy($strategy)`
`49`	`49`	`{`
`50`	`50`	`$this->environment->getExtension('escaper')->setDefaultStrategy($strategy);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`54`		`- * @deprecated Deprecated since version 2.3, to be removed in 3.0. Use TwigDefaultEscapingStrategy instead.`
	`54`	`+ * @deprecated since version 2.3, to be removed in 3.0.`
	`55`	`+ * Use TwigDefaultEscapingStrategy instead.`
`55`	`56`	`*/`
`56`	`57`	`public function guessDefaultEscapingStrategy($filename)`
`57`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\ClassLoader;`
`13`	`13`
	`14`	`+trigger_error('The '.__NAMESPACE__.'\ApcUniversalClassLoader class is deprecated since version 2.7 and will be removed in 3.0. Use the Symfony\Component\ClassLoader\ApcClassLoader class instead.', E_USER_DEPRECATED);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* ApcUniversalClassLoader implements a "universal" autoloader cached in APC for PHP 5.3.`
`16`	`18`	`*`
`@@ -60,7 +62,8 @@`
`60`	`62`	`*`
`61`	`63`	`* @api`
`62`	`64`	`*`
`63`		`- * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the ApcClassLoader class instead.`
	`65`	`+ * @deprecated since version 2.4, to be removed in 3.0.`
	`66`	`+ * Use the {@link ClassLoader} class instead.`
`64`	`67`	`*/`
`65`	`68`	`class ApcUniversalClassLoader extends UniversalClassLoader`
`66`	`69`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,15 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\ClassLoader;`
`13`	`13`
	`14`	`+trigger_error('The '.__NAMESPACE__.'\DebugUniversalClassLoader class is deprecated since version 2.4 and will be removed in 3.0. Use the Symfony\Component\Debug\DebugClassLoader class instead.', E_USER_DEPRECATED);`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Checks that the class is actually declared in the included file.`
`16`	`18`	`*`
`17`	`19`	`* @author Fabien Potencier <fabien@symfony.com>`
`18`	`20`	`*`
`19`		`- * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the DebugClassLoader provided by the Debug component instead.`
	`21`	`+ * @deprecated since version 2.4, to be removed in 3.0.`
	`22`	`+ * Use the {@link \Symfony\Component\Debug\DebugClassLoader} class instead.`
`20`	`23`	`*/`
`21`	`24`	`class DebugUniversalClassLoader extends UniversalClassLoader`
`22`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ private function getClassCandidates($class)`
`101`	`101`	`if ($function[0] instanceof DebugClassLoader) {`
`102`	`102`	`$function = $function[0]->getClassLoader();`
`103`	`103`
`104`		`- // Since 2.5, returning an object from DebugClassLoader::getClassLoader() is @deprecated`
	`104`	`+ // @deprecated since version 2.5. Returning an object from DebugClassLoader::getClassLoader() is deprecated.`
`105`	`105`	`if (is_object($function)) {`
`106`	`106`	`$function = array($function);`
`107`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ public function clear()`
`169`	`169`	`/**`
`170`	`170`	`* Returns an iterator for flashes.`
`171`	`171`	`*`
`172`		`- * @deprecated Will be removed in 3.0.`
	`172`	`+ * @deprecated since version 2.4, to be removed in 3.0.`
`173`	`173`	`*`
`174`	`174`	`* @return \ArrayIterator An \ArrayIterator instance`
`175`	`175`	`*/`