Merge origin/1.10.x into master (using imerge)

.github/workflows/continuous-integration.yml

@@ -22,6 +22,7 @@ jobs:
         with:
           coverage: "none"
           php-version: "${{ matrix.php-version }}"
+          tools: "cs2pr"
 
       - name: "Cache dependencies installed with composer"
         uses: "actions/cache@v1"
@@ -33,6 +34,5 @@ jobs:
       - name: "Install dependencies with composer"
         run: "composer install --no-interaction --no-progress --no-suggest"
 
-      # https://github.com/doctrine/annotations/issues/349
       - name: "Run PHP Code Beautifier"
-        run: "vendor/bin/phpcbf"
+        run: "vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr"

lib/Doctrine/Common/Annotations/Annotation.php

@@ -19,7 +19,7 @@ class Annotation
     public $value;
 
     /**
-     * @param array $data Key-value for properties to be defined in this class.
+     * @param array<string, mixed> $data Key-value for properties to be defined in this class.
      */
     final public function __construct(array $data)
     {

lib/Doctrine/Common/Annotations/Annotation/Enum.php

@@ -23,20 +23,20 @@
  */
 final class Enum
 {
-    /** @var array */
+    /** @phpstan-var list<scalar> */
     public $value;
 
     /**
      * Literal target declaration.
      *
-     * @var array
+     * @var mixed[]
      */
     public $literal;
 
     /**
-     * @param array $values
-     *
      * @throws InvalidArgumentException
+     *
+     * @phpstan-param array{literal?: mixed[], value: list<scalar>} $values
      */
     public function __construct(array $values)
     {

lib/Doctrine/Common/Annotations/Annotation/IgnoreAnnotation.php

@@ -17,13 +17,13 @@
  */
 final class IgnoreAnnotation
 {
-    /** @var array */
+    /** @phpstan-var list<string> */
     public $names;
 
     /**
-     * @param array $values
-     *
      * @throws RuntimeException
+     *
+     * @phpstan-param array{value: string|list<string>} $values
      */
     public function __construct(array $values)
     {
@@ -32,7 +32,10 @@ public function __construct(array $values)
         }
 
         if (! is_array($values['value'])) {
-            throw new RuntimeException(sprintf('@IgnoreAnnotation expects either a string name, or an array of strings, but got %s.', json_encode($values['value'])));
+            throw new RuntimeException(sprintf(
+                '@IgnoreAnnotation expects either a string name, or an array of strings, but got %s.',
+                json_encode($values['value'])
+            ));
         }
 
         $this->names = $values['value'];

lib/Doctrine/Common/Annotations/Annotation/Target.php

@@ -27,7 +27,7 @@ final class Target
     public const TARGET_ANNOTATION = 8;
     public const TARGET_ALL        = 15;
 
-    /** @var array */
+    /** @var array<string, int> */
     private static $map = [
         'ALL'        => self::TARGET_ALL,
         'CLASS'      => self::TARGET_CLASS,
@@ -36,7 +36,7 @@ final class Target
         'ANNOTATION' => self::TARGET_ANNOTATION,
     ];
 
-    /** @var array */
+    /** @phpstan-var list<string> */
     public $value;
 
     /**
@@ -54,9 +54,9 @@ final class Target
     public $literal;
 
     /**
-     * @param array $values
-     *
      * @throws InvalidArgumentException
+     *
+     * @phpstan-param array{value?: string|list<string>} $values
      */
     public function __construct(array $values)
     {

lib/Doctrine/Common/Annotations/AnnotationException.php

@@ -128,18 +128,19 @@ public static function requiredError($attributeName, $annotationName, $context,
     /**
      * Creates a new AnnotationException describing a invalid enummerator.
      *
-     * @param string $attributeName
-     * @param string $annotationName
-     * @param string $context
-     * @param array  $available
-     * @param mixed  $given
+     * @param string              $attributeName
+     * @param string              $annotationName
+     * @param string              $context
+     * @param object|class-string $given
      *
      * @return AnnotationException
+     *
+     * @phpstan-param list<string>        $available
      */
     public static function enumeratorError($attributeName, $annotationName, $context, $available, $given)
     {
         return new self(sprintf(
-            '[Enum Error] Attribute "%s" of @%s declared on %s accept only [%s], but got %s.',
+            '[Enum Error] Attribute "%s" of @%s declared on %s accepts only [%s], but got %s.',
             $attributeName,
             $annotationName,
             $context,

lib/Doctrine/Common/Annotations/AnnotationReader.php

@@ -21,7 +21,7 @@ class AnnotationReader implements Reader
     /**
      * Global map for imports.
      *
-     * @var array
+     * @var array<string, class-string>
      */
     private static $globalImports = [
         'ignoreannotation' => Annotation\IgnoreAnnotation::class,
@@ -32,7 +32,7 @@ class AnnotationReader implements Reader
      *
      * The names are case sensitive.
      *
-     * @var array
+     * @var array<string, true>
      */
     private static $globalIgnoredNames = ImplicitlyIgnoredAnnotationNames::LIST;
 
@@ -41,7 +41,7 @@ class AnnotationReader implements Reader
      *
      * The names are case sensitive.
      *
-     * @var array
+     * @var array<string, true>
      */
     private static $globalIgnoredNamespaces = [];
 
@@ -89,14 +89,14 @@ public static function addGlobalIgnoredNamespace($namespace)
     /**
      * In-memory cache mechanism to store imported annotations per class.
      *
-     * @var array
+     * @var array<string, array<string, class-string>>
      */
     private $imports = [];
 
     /**
      * In-memory cache mechanism to store ignored annotations per class.
      *
-     * @var array
+     * @var array<string, array<string, true>>
      */
     private $ignoredAnnotationNames = [];
 
@@ -107,7 +107,10 @@ public static function addGlobalIgnoredNamespace($namespace)
      */
     public function __construct(?DocParser $parser = null)
     {
-        if (extension_loaded('Zend Optimizer+') && (ini_get('zend_optimizerplus.save_comments') === '0' || ini_get('opcache.save_comments') === '0')) {
+        if (
+            extension_loaded('Zend Optimizer+') && (ini_get('zend_optimizerplus.save_comments') === '0' ||
+            ini_get('opcache.save_comments') === '0')
+        ) {
             throw AnnotationException::optimizerPlusSaveComments();
         }
 
@@ -225,7 +228,7 @@ public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
     /**
      * Returns the ignored annotations for the given class.
      *
-     * @return array
+     * @return array<string, true>
      */
     private function getIgnoredAnnotationNames(ReflectionClass $class)
     {
@@ -242,7 +245,7 @@ private function getIgnoredAnnotationNames(ReflectionClass $class)
     /**
      * Retrieves imports.
      *
-     * @return array
+     * @return array<string, class-string>
      */
     private function getClassImports(ReflectionClass $class)
     {
@@ -259,7 +262,7 @@ private function getClassImports(ReflectionClass $class)
     /**
      * Retrieves imports for methods.
      *
-     * @return array
+     * @return array<string, class-string>
      */
     private function getMethodImports(ReflectionMethod $method)
     {
@@ -285,7 +288,7 @@ private function getMethodImports(ReflectionMethod $method)
     /**
      * Retrieves imports for properties.
      *
-     * @return array
+     * @return array<string, class-string>
      */
     private function getPropertyImports(ReflectionProperty $property)
     {

lib/Doctrine/Common/Annotations/AnnotationRegistry.php

@@ -59,7 +59,8 @@ public static function reset(): void
     /**
      * Registers file.
      *
-     * @deprecated This method is deprecated and will be removed in doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
+     * @deprecated This method is deprecated and will be removed in
+     *             doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
      */
     public static function registerFile(string $file): void
     {
@@ -73,9 +74,10 @@ public static function registerFile(string $file): void
      *
      * Loading of this namespaces will be done with a PSR-0 namespace loading algorithm.
      *
-     * @deprecated This method is deprecated and will be removed in doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
+     * @deprecated This method is deprecated and will be removed in
+     *             doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
      *
-     * @param string|array|null $dirs
+     * @phpstan-param string|list<string>|null $dirs
      */
     public static function registerAutoloadNamespace(string $namespace, $dirs = null): void
     {
@@ -87,7 +89,8 @@ public static function registerAutoloadNamespace(string $namespace, $dirs = null
      *
      * Loading of this namespaces will be done with a PSR-0 namespace loading algorithm.
      *
-     * @deprecated This method is deprecated and will be removed in doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
+     * @deprecated This method is deprecated and will be removed in
+     *             doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
      *
      * @param string[][]|string[]|null[] $namespaces indexed by namespace name
      */
@@ -102,7 +105,8 @@ public static function registerAutoloadNamespaces(array $namespaces): void
      * NOTE: These class loaders HAVE to be silent when a class was not found!
      * IMPORTANT: Loaders have to return true if they loaded a class that could contain the searched annotation class.
      *
-     * @deprecated This method is deprecated and will be removed in doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
+     * @deprecated This method is deprecated and will be removed in
+     *             doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
      */
     public static function registerLoader(callable $callable): void
     {
@@ -114,7 +118,8 @@ public static function registerLoader(callable $callable): void
     /**
      * Registers an autoloading callable for annotations, if it is not already registered
      *
-     * @deprecated This method is deprecated and will be removed in doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
+     * @deprecated This method is deprecated and will be removed in
+     *             doctrine/annotations 2.0. Annotations will be autoloaded in 2.0.
      */
     public static function registerUniqueLoader(callable $callable): void
     {
@@ -146,7 +151,8 @@ public static function loadAnnotationClass(string $class): bool
             $file = str_replace('\\', DIRECTORY_SEPARATOR, $class) . '.php';
 
             if ($dirs === null) {
-                if ($path = stream_resolve_include_path($file)) {
+                $path = stream_resolve_include_path($file);
+                if ($path) {
                     require $path;
 
                     return true;
@@ -168,7 +174,12 @@ public static function loadAnnotationClass(string $class): bool
             }
         }
 
-        if (self::$loaders === [] && self::$autoloadNamespaces === [] && self::$registerFileUsed === false && class_exists($class)) {
+        if (
+            self::$loaders === [] &&
+            self::$autoloadNamespaces === [] &&
+            self::$registerFileUsed === false &&
+            class_exists($class)
+        ) {
             return true;
         }