minor #51974 [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties (alexandre-daubois)

nicolas-grekas · nicolas-grekas · commit 80e6e41ff49d · 2024-01-02T11:02:38.000+01:00
This PR was merged into the 7.1 branch. Discussion ---------- [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Part of symfony/symfony#51920 | License | MIT One more round. :information_source: A first review of this kind is being done [here](symfony/symfony#51971), I'll adjust this PR accordingly once done 🙂 Commits ------- 8a2ac5a6d2 [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties
diff --git a/Attribute/CurrentUser.php b/Attribute/CurrentUser.php
@@ -20,6 +20,10 @@
 #[\Attribute(\Attribute::TARGET_PARAMETER)]
 class CurrentUser extends ValueResolver
 {
+    /**
+     * @param bool   $disabled Whether this value resolver is disabled, which allows to enable a value resolver globally while disabling it in specific cases
+     * @param string $resolver The class name of the resolver to use
+     */
     public function __construct(bool $disabled = false, string $resolver = UserValueResolver::class)
     {
         parent::__construct($resolver, $disabled);
diff --git a/Attribute/IsGranted.php b/Attribute/IsGranted.php
@@ -14,38 +14,27 @@
 use Symfony\Component\ExpressionLanguage\Expression;
 
 /**
+ * Checks if user has permission to access to some resource using security roles and voters.
+ *
+ * @see https://symfony.com/doc/current/security.html#roles
+ *
  * @author Ryan Weaver <ryan@knpuniversity.com>
  */
 #[\Attribute(\Attribute::IS_REPEATABLE | \Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::TARGET_FUNCTION)]
 final class IsGranted
 {
+    /**
+     * @param string|Expression            $attribute     The attribute that will be checked against a given authentication token and optional subject
+     * @param array|string|Expression|null $subject       An optional subject - e.g. the current object being voted on
+     * @param string|null                  $message       A custom message when access is not granted
+     * @param int|null                     $statusCode    If set, will throw HttpKernel's HttpException with the given $statusCode; if null, Security\Core's AccessDeniedException will be used
+     * @param int|null                     $exceptionCode If set, will add the exception code to thrown exception
+     */
     public function __construct(
-        /**
-         * Sets the first argument that will be passed to isGranted().
-         */
         public string|Expression $attribute,
-
-        /**
-         * Sets the second argument passed to isGranted().
-         *
-         * @var array<string|Expression>|string|Expression|null
-         */
         public array|string|Expression|null $subject = null,
-
-        /**
-         * The message of the exception - has a nice default if not set.
-         */
         public ?string $message = null,
-
-        /**
-         * If set, will throw HttpKernel's HttpException with the given $statusCode.
-         * If null, Security\Core's AccessDeniedException will be used.
-         */
         public ?int $statusCode = null,
-
-        /**
-         * If set, will add the exception code to thrown exception.
-         */
         public ?int $exceptionCode = null,
     ) {
     }

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,10 @@`
`20`	`20`	`#[\Attribute(\Attribute::TARGET_PARAMETER)]`
`21`	`21`	`class CurrentUser extends ValueResolver`
`22`	`22`	`{`
	`23`	`+ /**`
	`24`	`+ * @param bool $disabled Whether this value resolver is disabled, which allows to enable a value resolver globally while disabling it in specific cases`
	`25`	`+ * @param string $resolver The class name of the resolver to use`
	`26`	`+ */`
`23`	`27`	`public function __construct(bool $disabled = false, string $resolver = UserValueResolver::class)`
`24`	`28`	`{`
`25`	`29`	`parent::__construct($resolver, $disabled);`