[DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971

alexandre-daubois · 2023-10-10T11:16:55Z

Q	A
Branch?	7.1
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Part of #51920
License	MIT

Friendly ping @GromNaN, is that what you had in mind? 🙂

GromNaN

Great work.

src/Symfony/Component/DependencyInjection/Attribute/AsAlias.php

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

src/Symfony/Component/DependencyInjection/Attribute/When.php

src/Symfony/Component/DependencyInjection/Attribute/AsAlias.php

src/Symfony/Component/DependencyInjection/Attribute/AutoconfigureTag.php

src/Symfony/Component/DependencyInjection/Attribute/AutowireServiceClosure.php

OskarStark · 2023-10-10T14:18:57Z

@GromNaN is there any reason, why we don't use proper @param annotations?

src/Symfony/Component/DependencyInjection/Attribute/TaggedLocator.php

src/Symfony/Component/DependencyInjection/Attribute/When.php

src/Symfony/Component/HttpKernel/Attribute/MapDateTime.php

src/Symfony/Component/DependencyInjection/Attribute/AsDecorator.php

src/Symfony/Component/DependencyInjection/Attribute/TaggedIterator.php

src/Symfony/Component/DependencyInjection/Attribute/AutoconfigureTag.php

src/Symfony/Component/DependencyInjection/Attribute/TaggedLocator.php

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

src/Symfony/Component/DependencyInjection/Attribute/AutowireLocator.php

GromNaN

LGTM after a few corrections to the types.

src/Symfony/Component/DependencyInjection/Attribute/Autoconfigure.php

src/Symfony/Component/HttpKernel/Attribute/MapQueryParameter.php

OskarStark · 2023-12-29T21:37:38Z

src/Symfony/Component/DependencyInjection/Attribute/AsAlias.php

@@ -20,7 +20,14 @@
 final class AsAlias
 {
    public function __construct(


@param should be used

Updated the whole PR 👍

…w] Add PHPDoc to attribute classes and properties (alexandre-daubois) 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 #51920 | License | MIT One more round. :information_source: A first review of this kind is being done [here](#51971), I'll adjust this PR accordingly once done 🙂 Commits ------- 8a2ac5a [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties

…w] Add PHPDoc to attribute classes and properties (alexandre-daubois) 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

nicolas-grekas · 2024-01-02T10:15:10Z

src/Symfony/Component/DependencyInjection/Attribute/AsDecorator.php

+    /**
+     * @param string $decorates The service id to decorate
+     * @param int    $priority  The priority of this decoration when multiple decorators are declared for the same service
+     * @param int    $onInvalid The behavior to adopt when the decoration is invalid. Must be one of the {@see ContainerInterface} constants


Suggested change

* @param int $onInvalid The behavior to adopt when the decoration is invalid. Must be one of the {@see ContainerInterface} constants

* @param int $onInvalid The behavior to adopt when the decoration is invalid; must be one of the {@see ContainerInterface} constants

nicolas-grekas · 2024-01-02T10:15:33Z

src/Symfony/Component/DependencyInjection/Attribute/AsTaggedItem.php

@@ -19,6 +19,10 @@
 #[\Attribute(\Attribute::TARGET_CLASS)]
 class AsTaggedItem
 {
+    /**
+     * @param string|null $index    The property or method to use to index the item in the locator
+     * @param int|null    $priority The priority of the item. The higher the number, the earlier the tagged service will be located in the locator


Suggested change

* @param int|null $priority The priority of the item. The higher the number, the earlier the tagged service will be located in the locator

* @param int|null $priority The priority of the item; the higher the number, the earlier the tagged service will be located in the locator

nicolas-grekas · 2024-01-02T10:17:45Z

src/Symfony/Component/DependencyInjection/Attribute/AutowireDecorated.php

@@ -11,6 +11,9 @@

 namespace Symfony\Component\DependencyInjection\Attribute;

+/**
+ * An attribute to autowire the inner object of decorating services.


Suggested change

* An attribute to autowire the inner object of decorating services.

* Autowires the inner object of decorating services.

nicolas-grekas · 2024-01-02T10:18:05Z

src/Symfony/Component/DependencyInjection/Attribute/AsDecorator.php

@@ -13,9 +13,17 @@

 use Symfony\Component\DependencyInjection\ContainerInterface;

+/**
+ * An attribute to declare a decorating service.


Suggested change

* An attribute to declare a decorating service.

* Declares a decorating service.

nicolas-grekas · 2024-01-02T10:20:56Z

src/Symfony/Component/DependencyInjection/Attribute/Target.php

-        public ?string $name = null,
-    ) {
+    /**
+     * @param string|null $name The service alias to autowire


Suggested change

* @param string|null $name The service alias to autowire

* @param string|null $name The name of the target autowiring alias

nicolas-grekas · 2024-01-02T10:23:33Z

src/Symfony/Component/HttpKernel/Attribute/MapDateTime.php

+    /**
+     * @param string|null  $format   The DateTime format to use, @see https://www.php.net/manual/en/datetime.format.php
+     * @param bool         $disabled Whether this value resolver is disabled. This allows to enable a value resolver globally while disabling it in specific cases.
+     * @param class-string $resolver The class name of the resolver to use


this doesn't have to be a FQCN, does it?

nicolas-grekas · 2024-01-02T10:24:11Z

src/Symfony/Component/HttpKernel/Attribute/MapQueryParameter.php

@@ -24,7 +24,11 @@ final class MapQueryParameter extends ValueResolver
    /**
     * @see https://php.net/filter.filters.validate for filter, flags and options
     *
-     * @param string|null $name The name of the query parameter. If null, the name of the argument in the controller will be used.
+     * @param string|null $name The name of the query parameter. If null, the name of the argument in the controller will be used


Suggested change

* @param string|null $name The name of the query parameter. If null, the name of the argument in the controller will be used

* @param string|null $name The name of the query parameter; if null, the name of the argument in the controller will be used

nicolas-grekas · 2024-01-02T10:24:44Z

src/Symfony/Component/HttpKernel/Attribute/ValueResolver.php

 #[\Attribute(\Attribute::TARGET_PARAMETER | \Attribute::IS_REPEATABLE)]
 class ValueResolver
 {
    /**
-     * @param class-string<ValueResolverInterface>|string $resolver
+     * @param class-string<ValueResolverInterface>|string $resolver The class name of the resolver to use
+     * @param bool                                        $disabled Whether this value resolver is disabled. This allows to enable a value resolver globally while disabling it in specific cases.


Suggested change

* @param bool $disabled Whether this value resolver is disabled. This allows to enable a value resolver globally while disabling it in specific cases.

* @param bool $disabled Whether this value resolver is disabled; this allows to enable a value resolver globally while disabling it in specific cases

nicolas-grekas · 2024-01-02T10:25:09Z

src/Symfony/Component/HttpKernel/Attribute/WithHttpStatus.php

@@ -12,16 +12,28 @@
 namespace Symfony\Component\HttpKernel\Attribute;

 /**
+ * An attribute to define the HTTP status code applied to an exception.


Suggested change

* An attribute to define the HTTP status code applied to an exception.

* Defines the HTTP status code applied to an exception.

nicolas-grekas · 2024-01-02T10:25:27Z

src/Symfony/Component/HttpKernel/Attribute/WithLogLevel.php

@@ -14,13 +14,15 @@
 use Psr\Log\LogLevel;

 /**
+ * An attribute to define the log level applied to an exception.


Suggested change

* An attribute to define the log level applied to an exception.

* Defines the log level applied to an exception.

nicolas-grekas · 2024-01-02T13:12:48Z

src/Symfony/Component/HttpKernel/Attribute/MapQueryParameter.php

@@ -24,7 +25,11 @@ final class MapQueryParameter extends ValueResolver
    /**
     * @see https://php.net/filter.filters.validate for filter, flags and options
     *
-     * @param string|null $name The name of the query parameter. If null, the name of the argument in the controller will be used.
+     * @param string|null                                         $name The name of the query parameter; if null, the name of the argument in the controller will be used


Suggested change

* @param string|null $name The name of the query parameter; if null, the name of the argument in the controller will be used

* @param string|null $name The name of the query parameter; if null, the name of the argument in the controller will be used

nicolas-grekas · 2024-01-02T13:13:41Z

src/Symfony/Component/HttpKernel/Attribute/ValueResolver.php

@@ -13,11 +13,15 @@

 use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;

+/**
+ * An attribute to tell which value resolver should be used for a given parameter.


Defines the value resolver to use for a given parameter.

nicolas-grekas · 2024-01-02T13:14:15Z

src/Symfony/Component/DependencyInjection/Attribute/Autoconfigure.php

+     * @param bool|null                                      $autowire     Whether to declare the service as autowired
+     * @param array<string, mixed>|null                      $properties   The properties to define when creating the service
+     * @param array<class-string, string>|string|null        $configurator A PHP function, reference or an array containing a class/Reference and a method to call after the service is fully initialized
+     * @param string|null                                    $constructor  The public static inner method to use to instantiate the service


Suggested change

* @param string|null $constructor The public static inner method to use to instantiate the service

* @param string|null $constructor The public static method to use to instantiate the service

alexandre-daubois · 2024-01-02T13:17:11Z

Fabbot's having (and giving) hard times with some of the advanced types 😅 Addressed remaining comments, thanks

… properties

nicolas-grekas · 2024-01-02T13:18:46Z

Thank you @alexandre-daubois.

carsonbot added Status: Needs Review DependencyInjection Feature HttpKernel labels Oct 10, 2023

carsonbot added this to the 6.4 milestone Oct 10, 2023

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch 2 times, most recently from 7224e66 to d774f7a Compare October 10, 2023 11:18

GromNaN reviewed Oct 10, 2023

View reviewed changes

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch 3 times, most recently from 1a2ff9b to 093bd61 Compare October 10, 2023 14:09

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AsAlias.php Outdated Show resolved Hide resolved

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutoconfigureTag.php Outdated Show resolved Hide resolved

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireServiceClosure.php Outdated Show resolved Hide resolved

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch 2 times, most recently from 5807835 to 0b7bb65 Compare October 10, 2023 14:20

GromNaN reviewed Oct 10, 2023

View reviewed changes

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch from 0b7bb65 to fce3ee9 Compare October 10, 2023 15:43

GromNaN reviewed Oct 10, 2023

View reviewed changes

stof reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutoconfigureTag.php Outdated Show resolved Hide resolved

alexandre-daubois mentioned this pull request Oct 10, 2023

[Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974

Merged

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch 4 times, most recently from 74cced5 to 3d46327 Compare October 10, 2023 17:02

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/TaggedLocator.php Outdated Show resolved Hide resolved

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Outdated Show resolved Hide resolved

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Outdated Show resolved Hide resolved

OskarStark reviewed Oct 10, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireLocator.php Outdated Show resolved Hide resolved

GromNaN reviewed Oct 18, 2023

View reviewed changes

GromNaN mentioned this pull request Oct 18, 2023

Improve PHPDoc descriptions of Attribute classes and parameters #51920

Closed

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch from 5611f41 to 4b2f2b2 Compare October 18, 2023 09:16

GromNaN mentioned this pull request Oct 18, 2023

Support global const pattern @var (FILTER_VALIDATE_*) vimeo/psalm#10291

Open

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch from 4b2f2b2 to 6d0a0ad Compare October 24, 2023 13:09

GromNaN added the ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" label Nov 1, 2023

nicolas-grekas removed the ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" label Nov 7, 2023

nicolas-grekas modified the milestones: 6.4, 7.1 Nov 15, 2023

OskarStark mentioned this pull request Dec 28, 2023

[Mailer] [Bridges] Use CPP and add more #[\SensitiveParameter] attributes #53241

Merged

OskarStark reviewed Dec 29, 2023

View reviewed changes

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch 3 times, most recently from e4a570b to 984e721 Compare December 30, 2023 16:48

nicolas-grekas reviewed Jan 2, 2024

View reviewed changes

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch from 984e721 to 7e2ae5a Compare January 2, 2024 13:07

nicolas-grekas reviewed Jan 2, 2024

View reviewed changes

alexandre-daubois force-pushed the attribues-docs-di-httpkernel branch 2 times, most recently from 0f2a4c0 to 0c171b5 Compare January 2, 2024 13:16

[DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and…

a9030f1

… properties

nicolas-grekas force-pushed the attribues-docs-di-httpkernel branch from 0c171b5 to a9030f1 Compare January 2, 2024 13:18

nicolas-grekas merged commit b990b26 into symfony:7.1 Jan 2, 2024

	* @param int $onInvalid The behavior to adopt when the decoration is invalid. Must be one of the {@see ContainerInterface} constants
	* @param int $onInvalid The behavior to adopt when the decoration is invalid; must be one of the {@see ContainerInterface} constants

	* @param int\|null $priority The priority of the item. The higher the number, the earlier the tagged service will be located in the locator
	* @param int\|null $priority The priority of the item; the higher the number, the earlier the tagged service will be located in the locator

	* An attribute to autowire the inner object of decorating services.
	* Autowires the inner object of decorating services.

	* An attribute to declare a decorating service.
	* Declares a decorating service.

	* @param string\|null $name The service alias to autowire
	* @param string\|null $name The name of the target autowiring alias

	* @param bool $disabled Whether this value resolver is disabled. This allows to enable a value resolver globally while disabling it in specific cases.
	* @param bool $disabled Whether this value resolver is disabled; this allows to enable a value resolver globally while disabling it in specific cases

	* An attribute to define the HTTP status code applied to an exception.
	* Defines the HTTP status code applied to an exception.

	* An attribute to define the log level applied to an exception.
	* Defines the log level applied to an exception.

	* @param string\|null $constructor The public static inner method to use to instantiate the service
	* @param string\|null $constructor The public static method to use to instantiate the service

Uh oh!

[DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971

[DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971

Uh oh!

Conversation

alexandre-daubois commented Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

OskarStark commented Oct 10, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexandre-daubois commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas commented Jan 2, 2024

Uh oh!

Uh oh!

alexandre-daubois commented Oct 10, 2023 •

edited

Loading

alexandre-daubois commented Jan 2, 2024 •

edited

Loading