Add Psalm

.github/workflows/static-analysis.yml

@@ -37,3 +37,28 @@ jobs:
       - name: "Run a static analysis with phpstan/phpstan"
         run: "vendor/bin/phpstan analyse"
         continue-on-error: true
+
+  static-analysis-psalm:
+    name: "Static Analysis with Psalm"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.0"
+
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+
+      - name: "Run a static analysis with vimeo/psalm"
+        run: "vendor/bin/psalm --show-info=false --stats --output-format=github --threads=$(nproc)"

composer.json

@@ -27,7 +27,8 @@
         "phpunit/phpunit": "^7.5.20 || ^8.5 || ^9.0",
         "doctrine/coding-standard": "^6.0 || ^8.0",
         "squizlabs/php_codesniffer": "^3.0",
-        "symfony/phpunit-bridge": "^4.0.5"
+        "symfony/phpunit-bridge": "^4.0.5",
+        "vimeo/psalm": "^4.4"
     },
     "autoload": {
         "psr-4": {

lib/Doctrine/Common/ClassLoader.php

@@ -171,6 +171,8 @@ public function unregister()
      * @param string $className The name of the class to load.
      *
      * @return bool TRUE if the class has been successfully loaded, FALSE otherwise.
+     *
+     * @psalm-param class-string $className
      */
     public function loadClass($className)
     {
@@ -196,6 +198,8 @@ public function loadClass($className)
      * @param string $className The fully-qualified name of the class.
      *
      * @return bool TRUE if this ClassLoader can load the class, FALSE otherwise.
+     *
+     * @psalm-param class-string $className
      */
     public function canLoadClass($className)
     {
@@ -233,6 +237,8 @@ public function canLoadClass($className)
      * @param string $className The fully-qualified name of the class.
      *
      * @return bool TRUE if the class exists as per the definition given above, FALSE otherwise.
+     *
+     * @psalm-param class-string $className
      */
     public static function classExists($className)
     {
@@ -246,6 +252,8 @@ public static function classExists($className)
      * @param string $className The name of the class.
      *
      * @return ClassLoader|null The <tt>ClassLoader</tt> for the class or NULL if no such <tt>ClassLoader</tt> exists.
+     *
+     * @psalm-param class-string $className
      */
     public static function getClassLoader($className)
     {

lib/Doctrine/Common/Proxy/AbstractProxyFactory.php

@@ -168,6 +168,8 @@ public function resetUninitializedProxy(Proxy $proxy)
      * @param string $className
      *
      * @return ProxyDefinition
+     *
+     * @psalm-param class-string $className
      */
     private function getProxyDefinition($className)
     {
@@ -218,6 +220,8 @@ abstract protected function skipClass(ClassMetadata $metadata);
      * @param string $className
      *
      * @return ProxyDefinition
+     *
+     * @psalm-param class-string $className
      */
     abstract protected function createProxyDefinition($className);
 }

lib/Doctrine/Common/Proxy/Autoloader.php

@@ -38,6 +38,8 @@ class Autoloader
      * @return string
      *
      * @throws InvalidArgumentException
+     *
+     * @psalm-param class-string $className
      */
     public static function resolveFile($proxyDir, $proxyNamespace, $className)
     {

lib/Doctrine/Common/Proxy/Exception/InvalidArgumentException.php

@@ -31,6 +31,8 @@ public static function proxyDirectoryRequired()
      * @param string $proxyNamespace
      *
      * @return self
+     *
+     * @psalm-param class-string $className
      */
     public static function notProxyClass($className, $proxyNamespace)
     {
@@ -79,6 +81,8 @@ public static function invalidClassNotFoundCallback($callback)
      * @param string $className
      *
      * @return self
+     *
+     * @psalm-param class-string $className
      */
     public static function classMustNotBeAbstract($className)
     {
@@ -89,6 +93,8 @@ public static function classMustNotBeAbstract($className)
      * @param string $className
      *
      * @return self
+     *
+     * @psalm-param class-string $className
      */
     public static function classMustNotBeFinal($className)
     {

lib/Doctrine/Common/Proxy/Exception/OutOfBoundsException.php

@@ -18,6 +18,8 @@ class OutOfBoundsException extends BaseOutOfBoundsException implements ProxyExce
      * @param string $idField
      *
      * @return self
+     *
+     * @psalm-param class-string $className
      */
     public static function missingPrimaryKeyValue($className, $idField)
     {

lib/Doctrine/Common/Proxy/Exception/UnexpectedValueException.php

@@ -30,6 +30,8 @@ public static function proxyDirectoryNotWritable($proxyDirectory)
      * @param string $parameterName
      *
      * @return self
+     *
+     * @psalm-param class-string $className
      */
     public static function invalidParameterTypeHint(
         $className,
@@ -54,6 +56,8 @@ public static function invalidParameterTypeHint(
      * @param string $methodName
      *
      * @return self
+     *
+     * @psalm-param class-string $className
      */
     public static function invalidReturnTypeHint($className, $methodName, ?Throwable $previous = null)
     {

lib/Doctrine/Common/Proxy/ProxyGenerator.php

@@ -891,6 +891,8 @@ private function generateMethods(ClassMetadata $class)
      *                              EntityManager will be used by this factory.
      *
      * @return string
+     *
+     * @psalm-param class-string $className
      */
     public function getProxyFileName($className, $baseDirectory = null)
     {

lib/Doctrine/Common/Util/ClassUtils.php

@@ -21,19 +21,22 @@ class ClassUtils
     /**
      * Gets the real class name of a class name that could be a proxy.
      *
-     * @param string $class
+     * @param string $className
      *
      * @return string
+     *
+     * @psalm-param class-string $className
+     * @psalm-return class-string
      */
-    public static function getRealClass($class)
+    public static function getRealClass($className)
     {
-        $pos = strrpos($class, '\\' . Proxy::MARKER . '\\');
+        $pos = strrpos($className, '\\' . Proxy::MARKER . '\\');
 
         if ($pos === false) {
-            return $class;
+            return $className;
         }
 
-        return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
+        return substr($className, $pos + Proxy::MARKER_LENGTH + 2);
     }
 
     /**
@@ -42,6 +45,8 @@ public static function getRealClass($class)
      * @param object $object
      *
      * @return string
+     *
+     * @psalm-return class-string
      */
     public static function getClass($object)
     {
@@ -54,6 +59,9 @@ public static function getClass($object)
      * @param string $className
      *
      * @return string
+     *
+     * @psalm-param class-string $className
+     * @psalm-return class-string
      */
     public static function getParentClass($className)
     {
@@ -63,13 +71,15 @@ public static function getParentClass($className)
     /**
      * Creates a new reflection class.
      *
-     * @param string $class
+     * @param string $className
      *
      * @return ReflectionClass
+     *
+     * @psalm-param class-string $className
      */
-    public static function newReflectionClass($class)
+    public static function newReflectionClass($className)
     {
-        return new ReflectionClass(self::getRealClass($class));
+        return new ReflectionClass(self::getRealClass($className));
     }
 
     /**
@@ -91,6 +101,9 @@ public static function newReflectionObject($object)
      * @param string $proxyNamespace
      *
      * @return string
+     *
+     * @psalm-param class-string $className
+     * @psalm-return class-string
      */
     public static function generateProxyClassName($className, $proxyNamespace)
     {

psalm.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="8"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    phpVersion="8.0"
+>
+    <projectFiles>
+        <directory name="lib/Doctrine/Common" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>