Document lowercase-string when possible (vimeo#4904)

* document lowercase-string * fix missing strtolower
danog · Jan 29, 2021 · bc900b2 · bc900b2
1 parent 8908877
commit bc900b2
Show file tree

Hide file tree

Showing 113 changed files with 227 additions and 152 deletions.
diff --git a/src/Psalm/Aliases.php b/src/Psalm/Aliases.php
@@ -4,22 +4,22 @@
 class Aliases
 {
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     public $uses;
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     public $uses_flipped;
 
     /**
-     * @var array<string, non-empty-string>
+     * @var array<lowercase-string, non-empty-string>
      */
     public $functions;
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     public $functions_flipped;
 
@@ -46,11 +46,11 @@ class Aliases
     public $uses_end;
 
     /**
-     * @param array<string, string> $uses
-     * @param array<string, non-empty-string> $functions
+     * @param array<lowercase-string, string> $uses
+     * @param array<lowercase-string, non-empty-string> $functions
      * @param array<string, string> $constants
-     * @param array<string, string> $uses_flipped
-     * @param array<string, string> $functions_flipped
+     * @param array<lowercase-string, string> $uses_flipped
+     * @param array<lowercase-string, string> $functions_flipped
      * @param array<string, string> $constants_flipped
      */
     public function __construct(

diff --git a/src/Psalm/Codebase.php b/src/Psalm/Codebase.php
@@ -51,15 +51,15 @@ class Codebase
      * A map of fully-qualified use declarations to the files
      * that reference them (keyed by filename)
      *
-     * @var array<string, array<int, \Psalm\CodeLocation>>
+     * @var array<lowercase-string, array<int, \Psalm\CodeLocation>>
      */
     public $use_referencing_locations = [];
 
     /**
      * A map of file names to the classes that they contain explicit references to
      * used in collaboration with use_referencing_locations
      *
-     * @var array<string, array<string, bool>>
+     * @var array<string, array<lowercase-string, bool>>
      */
     public $use_referencing_files = [];
 
@@ -235,7 +235,7 @@ class Codebase
     public $classes_to_move = [];
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     public $call_transforms = [];
 

diff --git a/src/Psalm/Config.php b/src/Psalm/Config.php
@@ -397,7 +397,7 @@ class Config
     public $ensure_array_int_offsets_exist = false;
 
     /**
-     * @var array<string, bool>
+     * @var array<lowercase-string, bool>
      */
     public $forbidden_functions = [];
 
@@ -591,7 +591,7 @@ class Config
     /**
      * Custom functions that always exit
      *
-     * @var array<string, bool>
+     * @var array<lowercase-string, bool>
      */
     public $exit_functions = [];
 

diff --git a/src/Psalm/Context.php b/src/Psalm/Context.php
@@ -142,7 +142,7 @@ class Context
     /**
      * A list of classes checked with class_exists
      *
-     * @var array<string,bool>
+     * @var array<lowercase-string,bool>
      */
     public $phantom_classes = [];
 

diff --git a/src/Psalm/Internal/Analyzer/CanAlias.php b/src/Psalm/Internal/Analyzer/CanAlias.php
@@ -11,27 +11,27 @@
 trait CanAlias
 {
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     private $aliased_classes = [];
 
     /**
-     * @var array<string, CodeLocation>
+     * @var array<lowercase-string, CodeLocation>
      */
     private $aliased_class_locations = [];
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     private $aliased_classes_flipped = [];
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     private $aliased_classes_flipped_replaceable = [];
 
     /**
-     * @var array<string, non-empty-string>
+     * @var array<lowercase-string, non-empty-string>
      */
     private $aliased_functions = [];
 
@@ -132,7 +132,7 @@ public function visitGroupUse(PhpParser\Node\Stmt\GroupUse $stmt): void
     }
 
     /**
-     * @return array<string, string>
+     * @return array<lowercase-string, string>
      */
     public function getAliasedClassesFlipped(): array
     {

diff --git a/src/Psalm/Internal/Analyzer/ClassLikeAnalyzer.php b/src/Psalm/Internal/Analyzer/ClassLikeAnalyzer.php
@@ -421,7 +421,7 @@ public static function getFQCLNFromNameObject(
     }
 
     /**
-     * @return array<string, string>
+     * @return array<lowercase-string, string>
      */
     public function getAliasedClassesFlipped(): array
     {

diff --git a/src/Psalm/Internal/Analyzer/FileAnalyzer.php b/src/Psalm/Internal/Analyzer/FileAnalyzer.php
@@ -67,7 +67,7 @@ class FileAnalyzer extends SourceAnalyzer
     private $namespace_aliased_classes = [];
 
     /**
-     * @var array<string, array<string, string>>
+     * @var array<string, array<lowercase-string, string>>
      */
     private $namespace_aliased_classes_flipped = [];
 
@@ -77,7 +77,7 @@ class FileAnalyzer extends SourceAnalyzer
     private $namespace_aliased_classes_flipped_replaceable = [];
 
     /**
-     * @var array<string, InterfaceAnalyzer>
+     * @var array<lowercase-string, InterfaceAnalyzer>
      */
     public $interface_analyzers_to_analyze = [];
 
@@ -351,7 +351,7 @@ private function populateClassLikeAnalyzers(PhpParser\Node\Stmt\ClassLike $stmt)
 
             $fq_class_name = $class_analyzer->getFQCLN();
 
-            $this->interface_analyzers_to_analyze[$fq_class_name] = $class_analyzer;
+            $this->interface_analyzers_to_analyze[strtolower($fq_class_name)] = $class_analyzer;
         }
     }
 
@@ -448,7 +448,7 @@ public function getNamespace(): ?string
     }
 
     /**
-     * @return array<string, string>
+     * @return array<lowercase-string, string>
      */
     public function getAliasedClassesFlipped(?string $namespace_name = null): array
     {

diff --git a/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php b/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php
@@ -1765,7 +1765,7 @@ public function getId() : string
     }
 
     /**
-     * @return array<string, string>
+     * @return array<lowercase-string, string>
      */
     public function getAliasedClassesFlipped(): array
     {

diff --git a/src/Psalm/Internal/Analyzer/ScopeAnalyzer.php b/src/Psalm/Internal/Analyzer/ScopeAnalyzer.php
@@ -61,11 +61,12 @@ public static function doesEverBreak(array $stmts): bool
     }
 
     /**
-     * @param   array<PhpParser\Node> $stmts
-     * @param   bool $return_is_exit Exit and Throw statements are treated differently from return if this is false
-     * @param   list<'loop'|'switch'> $break_types
+     * @param array<PhpParser\Node> $stmts
+     * @param array<lowercase-string, bool> $exit_functions
+     * @param list<'loop'|'switch'> $break_types
+     * @param bool $return_is_exit Exit and Throw statements are treated differently from return if this is false
      *
-     * @return  list<self::ACTION_*>
+     * @return list<self::ACTION_*>
      */
     public static function getControlActions(
         array $stmts,

diff --git a/src/Psalm/Internal/Analyzer/SourceAnalyzer.php b/src/Psalm/Internal/Analyzer/SourceAnalyzer.php
@@ -27,7 +27,7 @@ public function getAliases(): Aliases
     }
 
     /**
-     * @return array<string, string>
+     * @return array<lowercase-string, string>
      */
     public function getAliasedClassesFlipped(): array
     {

diff --git a/src/Psalm/Internal/Analyzer/TraitAnalyzer.php b/src/Psalm/Internal/Analyzer/TraitAnalyzer.php
@@ -41,7 +41,7 @@ public function getAliases(): Aliases
     }
 
     /**
-     * @return array<string, string>
+     * @return array<lowercase-string, string>
      */
     public function getAliasedClassesFlipped(): array
     {

diff --git a/src/Psalm/Internal/Codebase/ClassLikes.php b/src/Psalm/Internal/Codebase/ClassLikes.php
@@ -93,7 +93,7 @@ class ClassLikes
     private $existing_traits = [];
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     private $classlike_aliases = [];
 
@@ -557,7 +557,7 @@ public function interfaceExtends(string $interface_name, string $possible_parent
     }
 
     /**
-     * @return array<string, string>   all interfaces extended by $interface_name
+     * @return array<lowercase-string, string>   all interfaces extended by $interface_name
      */
     public function getParentInterfaces(string $fq_interface_name): array
     {

diff --git a/src/Psalm/Internal/Codebase/InternalCallMapHandler.php b/src/Psalm/Internal/Codebase/InternalCallMapHandler.php
@@ -38,7 +38,7 @@ class InternalCallMapHandler
     private static $loaded_php_minor_version = null;
 
     /**
-     * @var array<array<int|string,string>>|null
+     * @var array<lowercase-string, array<int|string,string>>|null
      */
     private static $call_map = null;
 

diff --git a/src/Psalm/Internal/Codebase/PropertyMap.php b/src/Psalm/Internal/Codebase/PropertyMap.php
@@ -9,14 +9,14 @@
 class PropertyMap
 {
     /**
-     * @var array<string, array<string, string>>|null
+     * @var array<lowercase-string, array<string, string>>|null
      */
     private static $property_map;
 
     /**
      * Gets the method/function call map
      *
-     * @return array<string, array<string, string>>
+     * @return array<lowercase-string, array<string, string>>
      */
     public static function getPropertyMap(): array
     {

diff --git a/src/Psalm/Internal/Codebase/Scanner.php b/src/Psalm/Internal/Codebase/Scanner.php
@@ -53,7 +53,7 @@
  *     unchanged_signature_members:array<string, array<string, bool>>,
  *     diff_map:array<string, array<int, array{0:int, 1:int, 2:int, 3:int}>>,
  *     classlike_storage:array<string, \Psalm\Storage\ClassLikeStorage>,
- *     file_storage:array<string, \Psalm\Storage\FileStorage>,
+ *     file_storage:array<lowercase-string, \Psalm\Storage\FileStorage>,
  *     new_file_content_hashes: array<string, string>,
  *     taint_data: ?TaintFlowGraph
  * }

diff --git a/src/Psalm/Internal/Provider/FileProvider.php b/src/Psalm/Internal/Provider/FileProvider.php
@@ -12,12 +12,12 @@
 class FileProvider
 {
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     protected $temp_files = [];
 
     /**
-     * @var array<string, string>
+     * @var array<lowercase-string, string>
      */
     protected $open_files = [];
 

diff --git a/src/Psalm/Internal/Provider/FileStorageProvider.php b/src/Psalm/Internal/Provider/FileStorageProvider.php
@@ -14,7 +14,7 @@ class FileStorageProvider
      * A list of data useful to analyse files
      * Storing this statically is much faster (at least in PHP 7.2.1)
      *
-     * @var array<string, FileStorage>
+     * @var array<lowercase-string, FileStorage>
      */
     private static $storage = [];
 
@@ -81,7 +81,7 @@ public function has(string $file_path, ?string $file_contents = null): bool
     }
 
     /**
-     * @return array<string, FileStorage>
+     * @return array<lowercase-string, FileStorage>
      */
     public function getAll(): array
     {
@@ -97,8 +97,7 @@ public function getNew(): array
     }
 
     /**
-     * @param array<string, FileStorage> $more
-     *
+     * @param array<lowercase-string, FileStorage> $more
      */
     public function addMore(array $more): void
     {

diff --git a/src/Psalm/Internal/Provider/FunctionExistenceProvider.php b/src/Psalm/Internal/Provider/FunctionExistenceProvider.php
@@ -10,7 +10,7 @@ class FunctionExistenceProvider
 {
     /**
      * @var array<
-     *   string,
+     *   lowercase-string,
      *   array<\Closure(
      *     StatementsSource,
      *     string
@@ -38,7 +38,7 @@ public function registerClass(string $class): void
     }
 
     /**
-     * /**
+     * @param lowercase-string $function_id
      * @param \Closure(
      *     StatementsSource,
      *     string

diff --git a/src/Psalm/Internal/Provider/FunctionParamsProvider.php b/src/Psalm/Internal/Provider/FunctionParamsProvider.php
@@ -12,7 +12,7 @@ class FunctionParamsProvider
 {
     /**
      * @var array<
-     *   string,
+     *   lowercase-string,
      *   array<\Closure(
      *     StatementsSource,
      *     string,

diff --git a/src/Psalm/Internal/Provider/FunctionReturnTypeProvider.php b/src/Psalm/Internal/Provider/FunctionReturnTypeProvider.php
@@ -13,7 +13,7 @@ class FunctionReturnTypeProvider
 {
     /**
      * @var array<
-     *   string,
+     *   lowercase-string,
      *   array<\Closure(
      *     StatementsSource,
      *     non-empty-string,
@@ -72,7 +72,7 @@ public function registerClass(string $class): void
     }
 
     /**
-     * /**
+     * @param lowercase-string $function_id
      * @param \Closure(
      *     StatementsSource,
      *     non-empty-string,

diff --git a/src/Psalm/Internal/Provider/MethodExistenceProvider.php b/src/Psalm/Internal/Provider/MethodExistenceProvider.php
@@ -11,7 +11,7 @@ class MethodExistenceProvider
 {
     /**
      * @var array<
-     *   string,
+     *   lowercase-string,
      *   array<\Closure(
      *     string,
      *     string,

diff --git a/src/Psalm/Internal/Provider/MethodParamsProvider.php b/src/Psalm/Internal/Provider/MethodParamsProvider.php
@@ -12,7 +12,7 @@ class MethodParamsProvider
 {
     /**
      * @var array<
-     *   string,
+     *   lowercase-string,
      *   array<\Closure(
      *     string,
      *     string,

diff --git a/src/Psalm/Internal/Provider/MethodReturnTypeProvider.php b/src/Psalm/Internal/Provider/MethodReturnTypeProvider.php
@@ -13,7 +13,7 @@ class MethodReturnTypeProvider
 {
     /**
      * @var array<
-     *   string,
+     *   lowercase-string,
      *   array<\Closure(
      *     StatementsSource,
      *     string,