Add links to documentation to ApiResource properties

Author: edamov

src/Annotation/ApiResource.php

@@ -25,10 +25,6 @@
  * @Attributes(
  *     @Attribute("accessControl", type="string"),
  *     @Attribute("accessControlMessage", type="string"),
- *     @Attribute("security", type="string"),
- *     @Attribute("securityMessage", type="string"),
- *     @Attribute("securityPostDenormalize", type="string"),
- *     @Attribute("securityPostDenormalizeMessage", type="string"),
  *     @Attribute("attributes", type="array"),
  *     @Attribute("cacheHeaders", type="array"),
  *     @Attribute("collectionOperations", type="array"),
@@ -62,6 +58,10 @@
  *     @Attribute("paginationPartial", type="bool"),
  *     @Attribute("paginationViaCursor", type="array"),
  *     @Attribute("routePrefix", type="string"),
+ *     @Attribute("security", type="string"),
+ *     @Attribute("securityMessage", type="string"),
+ *     @Attribute("securityPostDenormalize", type="string"),
+ *     @Attribute("securityPostDenormalizeMessage", type="string"),
  *     @Attribute("shortName", type="string"),
  *     @Attribute("subresourceOperations", type="array"),
  *     @Attribute("sunset", type="string"),
@@ -74,83 +74,66 @@ final class ApiResource
     use AttributesHydratorTrait;
 
     /**
-     * @var string
-     */
-    public $shortName;
-
-    /**
-     * @var string
-     */
-    public $description;
-
-    /**
-     * @var string
-     */
-    public $iri;
-
-    /**
-     * @var array
-     */
-    public $itemOperations;
-
-    /**
+     * @see https://api-platform.com/docs/core/operations
+     *
      * @var array
      */
     public $collectionOperations;
 
     /**
-     * @var array
+     * @var string
      */
-    public $subresourceOperations;
+    public $description;
 
     /**
+     * @see https://api-platform.com/docs/core/graphql
+     *
      * @var array
      */
     public $graphql;
 
     /**
-     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
-     *
      * @var string
      */
-    private $security;
+    public $iri;
 
     /**
-     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     * @see https://api-platform.com/docs/core/operations
      *
-     * @var string
+     * @var array
      */
-    private $securityMessage;
+    public $itemOperations;
 
     /**
-     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
-     *
      * @var string
      */
-    private $securityPostDenormalize;
+    public $shortName;
 
     /**
-     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     * @see https://api-platform.com/docs/core/subresources
      *
-     * @var string
+     * @var array
      */
-    private $securityPostDenormalizeMessage;
+    public $subresourceOperations;
 
     /**
+     * @see https://api-platform.com/docs/core/performance/#setting-custom-http-cache-headers
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
     private $cacheHeaders;
 
     /**
+     * @see https://api-platform.com/docs/core/serialization/#using-serialization-groups
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
     private $denormalizationContext;
 
     /**
+     * @see https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var string
@@ -165,188 +148,244 @@ final class ApiResource
     private $elasticsearch;
 
     /**
+     * @see https://api-platform.com/docs/core/performance/#fetch-partial
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool
      */
     private $fetchPartial;
 
     /**
+     * @see https://api-platform.com/docs/core/performance/#force-eager
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool
      */
     private $forceEager;
 
     /**
+     * @see https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
     private $formats;
 
     /**
+     * @see https://api-platform.com/docs/core/filters/#doctrine-orm-and-mongodb-odm-filters
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var string[]
      */
     private $filters;
 
     /**
+     * @see https://api-platform.com/docs/core/extending-jsonld-context/#hydra
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var string[]
      */
     private $hydraContext;
 
     /**
+     * @see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var string|false
+     */
+    private $input;
+
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var int
+     *
+     * @deprecated - Use $paginationMaximumItemsPerPage instead
+     */
+    private $maximumItemsPerPage;
+
+    /**
+     * @see https://api-platform.com/docs/core/mercure
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var mixed
      */
     private $mercure;
 
     /**
+     * @see https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool|string
      */
     private $messenger;
 
     /**
+     * @see https://api-platform.com/docs/core/serialization/#using-serialization-groups
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
     private $normalizationContext;
 
     /**
+     * @see https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var array
+     */
+    private $openapiContext;
+
+    /**
+     * @see https://api-platform.com/docs/core/default-order/#overriding-default-order
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
     private $order;
 
     /**
+     * @see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var string|false
+     */
+    private $output;
+
+    /**
+     * @see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool
      */
     private $paginationClientEnabled;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-3
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool
      */
     private $paginationClientItemsPerPage;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-6
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool
      */
     private $paginationClientPartial;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#cursor-based-pagination
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var bool
+     * @var array
      */
-    private $paginationEnabled;
+    private $paginationViaCursor;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#for-a-specific-resource
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var bool
      */
-    private $paginationFetchJoinCollection;
+    private $paginationEnabled;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#controlling-the-behavior-of-the-doctrine-orm-paginator
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var int
+     * @var bool
      */
-    private $paginationItemsPerPage;
+    private $paginationFetchJoinCollection;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var int
-     *
-     * @deprecated - Use $paginationMaximumItemsPerPage instead
      */
-    private $maximumItemsPerPage;
+    private $paginationItemsPerPage;
 
     /**
+     * @see https://api-platform.com/docs/core/pagination/#changing-maximum-items-per-page
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var int
      */
     private $paginationMaximumItemsPerPage;
 
     /**
+     * @see https://api-platform.com/docs/core/performance/#partial-pagination
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var int
      */
     private $paginationPartial;
 
     /**
+     * @see https://api-platform.com/docs/core/operations/#prefixing-all-routes-of-all-operations
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var string
      */
     private $routePrefix;
 
     /**
+     * @see https://api-platform.com/docs/core/security
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var array
+     * @var string
      */
-    private $swaggerContext;
+    private $security;
 
     /**
+     * @see https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var mixed
+     * @var string
      */
-    private $validationGroups;
+    private $securityMessage;
 
     /**
+     * @see https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var string
      */
-    private $sunset;
+    private $securityPostDenormalize;
 
     /**
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var string|false
+     * @var string
      */
-    private $input;
+    private $securityPostDenormalizeMessage;
 
     /**
+     * @see https://api-platform.com/docs/core/deprecations/#setting-the-sunset-http-header-to-indicate-when-a-resource-or-an-operation-will-be-removed
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var string|false
+     * @var string
      */
-    private $output;
+    private $sunset;
 
     /**
+     * @see https://api-platform.com/docs/core/swagger/#using-the-openapi-and-swagger-contexts
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
      * @var array
      */
-    private $openapiContext;
+    private $swaggerContext;
 
     /**
+     * @see https://api-platform.com/docs/core/validation/#using-validation-groups
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *
-     * @var array
+     * @var mixed
      */
-    private $paginationViaCursor;
+    private $validationGroups;
 
     /**
      * @throws InvalidArgumentException