feature #21388 [Debug] Deprecate ContextErrorException (nicolas-grekas)

fabpot · fabpot · commit 84a54838452a · 2017-01-24T07:53:04.000-08:00
This PR was merged into the 3.3-dev branch. Discussion ---------- [Debug] Deprecate ContextErrorException | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Since the `$context` argument is going to be deprecated in PHP 7.2 (see https://wiki.php.net/rfc/deprecations_php_7_2#errcontext_argument_of_error_handler), let's deprecate ContextErrorException altogether. Commits ------- c379707 [Debug] Deprecate ContextErrorException
diff --git a/UPGRADE-3.3.md b/UPGRADE-3.3.md
@@ -6,6 +6,11 @@ ClassLoader
 
  * The component is deprecated and will be removed in 4.0. Use Composer instead.
 
+Debug
+-----
+
+ * The `ContextErrorException` class is deprecated. `\ErrorException` will be used instead in 4.0.
+
 DependencyInjection
 -------------------
 
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -15,6 +15,9 @@ Console
 Debug
 -----
 
+
+ * The `ContextErrorException` class has been removed. Use `\ErrorException` instead.
+
  * `FlattenException::getTrace()` now returns additional type descriptions
    `integer` and `float`.
 
diff --git a/src/Symfony/Component/Debug/CHANGELOG.md b/src/Symfony/Component/Debug/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+3.3.0
+-----
+
+* deprecated the `ContextErrorException` class: use \ErrorException directly now
+
 3.2.0
 -----
 
diff --git a/src/Symfony/Component/Debug/ErrorHandler.php b/src/Symfony/Component/Debug/ErrorHandler.php
@@ -521,9 +521,6 @@ public function handleException($exception, array $error = null)
                 }
             } elseif ($exception instanceof \ErrorException) {
                 $message = 'Uncaught '.$exception->getMessage();
-                if ($exception instanceof ContextErrorException) {
-                    $e['context'] = $exception->getContext();
-                }
             } else {
                 $message = 'Uncaught Exception: '.$exception->getMessage();
             }
diff --git a/src/Symfony/Component/Debug/Exception/ContextErrorException.php b/src/Symfony/Component/Debug/Exception/ContextErrorException.php
@@ -15,6 +15,8 @@
  * Error Exception with Variable Context.
  *
  * @author Christian Sciberras <uuf6429@gmail.com>
+ *
+ * @deprecated since version 3.3. Instead, \ErrorException will be used directly in 4.0.
  */
 class ContextErrorException extends \ErrorException
 {
@@ -31,6 +33,8 @@ public function __construct($message, $code, $severity, $filename, $lineno, $con
      */
     public function getContext()
     {
+        @trigger_error(sprintf('The %s class is deprecated since version 3.3 and will be removed in 4.0.', __CLASS__), E_USER_DEPRECATED);
+
         return $this->context;
     }
 }
diff --git a/src/Symfony/Component/Debug/Tests/ErrorHandlerTest.php b/src/Symfony/Component/Debug/Tests/ErrorHandlerTest.php
@@ -14,7 +14,6 @@
 use Psr\Log\LogLevel;
 use Symfony\Component\Debug\BufferingLogger;
 use Symfony\Component\Debug\ErrorHandler;
-use Symfony\Component\Debug\Exception\ContextErrorException;
 use Symfony\Component\Debug\Exception\SilencedErrorContext;
 
 /**
@@ -71,13 +70,12 @@ public function testNotice()
 
         try {
             self::triggerNotice($this);
-            $this->fail('ContextErrorException expected');
-        } catch (ContextErrorException $exception) {
+            $this->fail('ErrorException expected');
+        } catch (\ErrorException $exception) {
             // if an exception is thrown, the test passed
             $this->assertEquals(E_NOTICE, $exception->getSeverity());
             $this->assertEquals(__FILE__, $exception->getFile());
             $this->assertRegExp('/^Notice: Undefined variable: (foo|bar)/', $exception->getMessage());
-            $this->assertArrayHasKey('foobar', $exception->getContext());
 
             $trace = $exception->getTrace();
 

Original file line number	Diff line number	Diff line change
`@@ -521,9 +521,6 @@ public function handleException($exception, array $error = null)`
`521`	`521`	`}`
`522`	`522`	`} elseif ($exception instanceof \ErrorException) {`
`523`	`523`	`$message = 'Uncaught '.$exception->getMessage();`
`524`		`- if ($exception instanceof ContextErrorException) {`
`525`		`- $e['context'] = $exception->getContext();`
`526`		`- }`
`527`	`524`	`} else {`
`528`	`525`	`$message = 'Uncaught Exception: '.$exception->getMessage();`
`529`	`526`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`* Error Exception with Variable Context.`
`16`	`16`	`*`
`17`	`17`	`* @author Christian Sciberras <[email protected]>`
	`18`	`+ *`
	`19`	`+ * @deprecated since version 3.3. Instead, \ErrorException will be used directly in 4.0.`
`18`	`20`	`*/`
`19`	`21`	`class ContextErrorException extends \ErrorException`
`20`	`22`	`{`
`@@ -31,6 +33,8 @@ public function __construct($message, $code, $severity, $filename, $lineno, $con`
`31`	`33`	`*/`
`32`	`34`	`public function getContext()`
`33`	`35`	`{`
	`36`	`+ @trigger_error(sprintf('The %s class is deprecated since version 3.3 and will be removed in 4.0.', __CLASS__), E_USER_DEPRECATED);`
	`37`	`+`
`34`	`38`	`return $this->context;`
`35`	`39`	`}`
`36`	`40`	`}`