feature #48876 [HttpKernel] Rename HttpStatus atribute to WithHttpStatus (fabpot)

fabpot · fabpot · commit f4a9a5d14612 · 2023-01-06T07:51:55.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [HttpKernel] Rename HttpStatus atribute to WithHttpStatus | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes-ish | New feature? | no  | Deprecations? | no  | Tickets | Refs #48352 and #48747 As discussed in the 2 referenced PRs for better naming consistency. Commits ------- fece766 [HttpKernel] Rename HttpStatus atribute to WithHttpStatus
diff --git a/src/Symfony/Component/HttpKernel/Attribute/WithHttpStatus.php b/src/Symfony/Component/HttpKernel/Attribute/WithHttpStatus.php
@@ -15,7 +15,7 @@
  * @author Dejan Angelov <angelovdejan@protonmail.com>
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-class HttpStatus
+class WithHttpStatus
 {
     /**
      * @param array<string, string> $headers
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -6,7 +6,7 @@ CHANGELOG
 
  * Deprecate parameters `container.dumper.inline_factories` and `container.dumper.inline_class_loader`, use `.container.dumper.inline_factories` and `.container.dumper.inline_class_loader` instead
  * `FileProfilerStorage` removes profiles automatically after two days
- * Add `#[HttpStatus]` for defining status codes for exceptions
+ * Add `#[WithHttpStatus]` for defining status codes for exceptions
  * Use an instance of `Psr\Clock\ClockInterface` to generate the current date time in `DateTimeValueResolver`
  * Add `#[WithLogLevel]` for defining log levels for exceptions
 
diff --git a/src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php b/src/Symfony/Component/HttpKernel/EventListener/ErrorListener.php
@@ -16,7 +16,7 @@
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Attribute\HttpStatus;
+use Symfony\Component\HttpKernel\Attribute\WithHttpStatus;
 use Symfony\Component\HttpKernel\Attribute\WithLogLevel;
 use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
@@ -71,10 +71,10 @@ public function logKernelException(ExceptionEvent $event)
         // There's no specific status code defined in the configuration for this exception
         if (!$throwable instanceof HttpExceptionInterface) {
             $class = new \ReflectionClass($throwable);
-            $attributes = $class->getAttributes(HttpStatus::class, \ReflectionAttribute::IS_INSTANCEOF);
+            $attributes = $class->getAttributes(WithHttpStatus::class, \ReflectionAttribute::IS_INSTANCEOF);
 
             if ($attributes) {
-                /** @var HttpStatus $instance */
+                /** @var WithHttpStatus $instance */
                 $instance = $attributes[0]->newInstance();
 
                 $throwable = new HttpException($instance->statusCode, $throwable->getMessage(), $throwable, $instance->headers);
diff --git a/src/Symfony/Component/HttpKernel/Tests/EventListener/ErrorListenerTest.php b/src/Symfony/Component/HttpKernel/Tests/EventListener/ErrorListenerTest.php
@@ -18,7 +18,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Attribute\HttpStatus;
+use Symfony\Component\HttpKernel\Attribute\WithHttpStatus;
 use Symfony\Component\HttpKernel\Attribute\WithLogLevel;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
 use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
@@ -321,7 +321,7 @@ public function handle(Request $request, $type = self::MAIN_REQUEST, $catch = tr
 }
 
 #[\Attribute(\Attribute::TARGET_CLASS)]
-class UserProvidedHttpStatusCodeAttribute extends HttpStatus
+class UserProvidedHttpStatusCodeAttribute extends WithHttpStatus
 {
     public function __construct(array $headers = [])
     {
@@ -339,7 +339,7 @@ class WithCustomUserProvidedAttribute extends \Exception
 {
 }
 
-#[HttpStatus(
+#[WithHttpStatus(
     statusCode: Response::HTTP_PRECONDITION_FAILED,
     headers: [
         'some' => 'thing',

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`* @author Dejan Angelov <[email protected]>`
`16`	`16`	`*/`
`17`	`17`	`#[\Attribute(\Attribute::TARGET_CLASS)]`
`18`		`-class HttpStatus`
	`18`	`+class WithHttpStatus`
`19`	`19`	`{`
`20`	`20`	`/**`
`21`	`21`	`* @param array<string, string> $headers`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`use Symfony\Component\EventDispatcher\EventDispatcher;`
`19`	`19`	`use Symfony\Component\HttpFoundation\Request;`
`20`	`20`	`use Symfony\Component\HttpFoundation\Response;`
`21`		`-use Symfony\Component\HttpKernel\Attribute\HttpStatus;`
	`21`	`+use Symfony\Component\HttpKernel\Attribute\WithHttpStatus;`
`22`	`22`	`use Symfony\Component\HttpKernel\Attribute\WithLogLevel;`
`23`	`23`	`use Symfony\Component\HttpKernel\Controller\ArgumentResolver;`
`24`	`24`	`use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;`
`@@ -321,7 +321,7 @@ public function handle(Request $request, $type = self::MAIN_REQUEST, $catch = tr`
`321`	`321`	`}`
`322`	`322`
`323`	`323`	`#[\Attribute(\Attribute::TARGET_CLASS)]`
`324`		`-class UserProvidedHttpStatusCodeAttribute extends HttpStatus`
	`324`	`+class UserProvidedHttpStatusCodeAttribute extends WithHttpStatus`
`325`	`325`	`{`
`326`	`326`	`public function __construct(array $headers = [])`
`327`	`327`	`{`
`@@ -339,7 +339,7 @@ class WithCustomUserProvidedAttribute extends \Exception`
`339`	`339`	`{`
`340`	`340`	`}`
`341`	`341`
`342`		`-#[HttpStatus(`
	`342`	`+#[WithHttpStatus(`
`343`	`343`	`statusCode: Response::HTTP_PRECONDITION_FAILED,`
`344`	`344`	`headers: [`
`345`	`345`	`'some' => 'thing',`