minor #40786 [Serializer][Validator] Update some phpDoc relative to "getters" (guilliamxavier)

fabpot · fabpot · commit 3f42c08abd7c · 2021-04-13T08:32:45.000+02:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- [Serializer][Validator] Update some phpDoc relative to "getters" | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yesish (phpDoc unaccurate after code updates) | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | Commits ------- 5046500 [Serializer][Validator] Update some phpDoc relative to "getters"
diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
@@ -61,7 +61,7 @@ public function hasCacheableSupportsMethod(): bool
     }
 
     /**
-     * Checks if the given class has any get{Property} method.
+     * Checks if the given class has any getter method.
      */
     private function supports(string $class): bool
     {
@@ -77,7 +77,7 @@ private function supports(string $class): bool
     }
 
     /**
-     * Checks if a method's name is get.* or is.*, and can be called without parameters.
+     * Checks if a method's name matches /^(get|is|has).+$/ and can be called non-statically without parameters.
      */
     private function isGetMethod(\ReflectionMethod $method): bool
     {
diff --git a/src/Symfony/Component/Validator/Mapping/ClassMetadata.php b/src/Symfony/Component/Validator/Mapping/ClassMetadata.php
@@ -237,7 +237,7 @@ public function addPropertyConstraints($property, array $constraints)
      * Adds a constraint to the getter of the given property.
      *
      * The name of the getter is assumed to be the name of the property with an
-     * uppercased first letter and either the prefix "get" or "is".
+     * uppercased first letter and the prefix "get", "is" or "has".
      *
      * @param string $property The name of the property
      *
diff --git a/src/Symfony/Component/Validator/Mapping/GetterMetadata.php b/src/Symfony/Component/Validator/Mapping/GetterMetadata.php
@@ -18,7 +18,7 @@
  * method.
  *
  * A property getter is any method that is equal to the property's name,
- * prefixed with either "get" or "is". That method will be used to access the
+ * prefixed with "get", "is" or "has". That method will be used to access the
  * property's value.
  *
  * The getter will be invoked by reflection, so the access of private and

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function hasCacheableSupportsMethod(): bool`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/**`
`64`		`- * Checks if the given class has any get{Property} method.`
	`64`	`+ * Checks if the given class has any getter method.`
`65`	`65`	`*/`
`66`	`66`	`private function supports(string $class): bool`
`67`	`67`	`{`
`@@ -77,7 +77,7 @@ private function supports(string $class): bool`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`/**`
`80`		`- * Checks if a method's name is get.* or is.*, and can be called without parameters.`
	`80`	`+ * Checks if a method's name matches /^(get\|is\|has).+$/ and can be called non-statically without parameters.`
`81`	`81`	`*/`
`82`	`82`	`private function isGetMethod(\ReflectionMethod $method): bool`
`83`	`83`	`{`
Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,7 @@ public function addPropertyConstraints($property, array $constraints)`
`237`	`237`	`* Adds a constraint to the getter of the given property.`
`238`	`238`	`*`
`239`	`239`	`* The name of the getter is assumed to be the name of the property with an`
`240`		`- * uppercased first letter and either the prefix "get" or "is".`
	`240`	`+ * uppercased first letter and the prefix "get", "is" or "has".`
`241`	`241`	`*`
`242`	`242`	`* @param string $property The name of the property`
`243`	`243`	`*`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`* method.`
`19`	`19`	`*`
`20`	`20`	`* A property getter is any method that is equal to the property's name,`
`21`		`- * prefixed with either "get" or "is". That method will be used to access the`
	`21`	`+ * prefixed with "get", "is" or "has". That method will be used to access the`
`22`	`22`	`* property's value.`
`23`	`23`	`*`
`24`	`24`	`* The getter will be invoked by reflection, so the access of private and`