Mark internal classes @internal

vimeo · Jan 3, 2022 · b924032 · b924032
1 parent b54ab67
commit b924032
Show file tree

Hide file tree

Showing 202 changed files with 579 additions and 297 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/src/Psalm/Internal/Algebra.php b/src/Psalm/Internal/Algebra.php
@@ -18,6 +18,9 @@
 use function mt_rand;
 use function substr;
 
+/**
+ * @internal
+ */
 class Algebra
 {
     /**

diff --git a/src/Psalm/Internal/Algebra/FormulaGenerator.php b/src/Psalm/Internal/Algebra/FormulaGenerator.php
@@ -19,6 +19,9 @@
 use function strlen;
 use function substr;
 
+/**
+ * @internal
+ */
 class FormulaGenerator
 {
      /**

diff --git a/src/Psalm/Internal/Analyzer/AttributeAnalyzer.php b/src/Psalm/Internal/Analyzer/AttributeAnalyzer.php
@@ -21,6 +21,9 @@
 
 use function reset;
 
+/**
+ * @internal
+ */
 class AttributeAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/ClassLikeNameOptions.php b/src/Psalm/Internal/Analyzer/ClassLikeNameOptions.php
@@ -2,6 +2,9 @@
 
 namespace Psalm\Internal\Analyzer;
 
+/**
+ * @internal
+ */
 class ClassLikeNameOptions
 {
     /** @var bool */

diff --git a/src/Psalm/Internal/Analyzer/DataFlowNodeData.php b/src/Psalm/Internal/Analyzer/DataFlowNodeData.php
@@ -4,6 +4,8 @@
 
 /**
  * @psalm-immutable
+ *
+ * @internal
  */
 class DataFlowNodeData
 {

diff --git a/src/Psalm/Internal/Analyzer/FunctionLike/ReturnTypeCollector.php b/src/Psalm/Internal/Analyzer/FunctionLike/ReturnTypeCollector.php
@@ -19,6 +19,8 @@
 
 /**
  * A class for analysing a given method call's effects in relation to $this/self and also looking at return types
+ *
+ * @internal
  */
 class ReturnTypeCollector
 {

diff --git a/src/Psalm/Internal/Analyzer/IssueData.php b/src/Psalm/Internal/Analyzer/IssueData.php
@@ -6,6 +6,9 @@
 
 use const STR_PAD_LEFT;
 
+/**
+ * @internal
+ */
 class IssueData
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/MethodComparator.php b/src/Psalm/Internal/Analyzer/MethodComparator.php
@@ -39,6 +39,9 @@
 use function strpos;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class MethodComparator
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Block/IfConditionalAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Block/IfConditionalAnalyzer.php
@@ -28,6 +28,9 @@
 use function array_values;
 use function count;
 
+/**
+ * @internal
+ */
 class IfConditionalAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Block/IfElse/ElseAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Block/IfElse/ElseAnalyzer.php
@@ -23,6 +23,9 @@
 use function preg_match;
 use function preg_quote;
 
+/**
+ * @internal
+ */
 class ElseAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Block/IfElse/ElseIfAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Block/IfElse/ElseIfAnalyzer.php
@@ -38,6 +38,9 @@
 use function preg_quote;
 use function spl_object_id;
 
+/**
+ * @internal
+ */
 class ElseIfAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Block/IfElse/IfAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Block/IfElse/IfAnalyzer.php
@@ -38,6 +38,9 @@
 use function strpos;
 use function substr;
 
+/**
+ * @internal
+ */
 class IfAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/BreakAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/BreakAnalyzer.php
@@ -10,6 +10,9 @@
 
 use function end;
 
+/**
+ * @internal
+ */
 class BreakAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/ContinueAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/ContinueAnalyzer.php
@@ -13,6 +13,9 @@
 
 use function end;
 
+/**
+ * @internal
+ */
 class ContinueAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/EchoAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/EchoAnalyzer.php
@@ -19,6 +19,9 @@
 use Psalm\Type;
 use Psalm\Type\TaintKind;
 
+/**
+ * @internal
+ */
 class EchoAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/ArrayCreationInfo.php b/src/Psalm/Internal/Analyzer/Statements/Expression/ArrayCreationInfo.php
@@ -6,6 +6,9 @@
 use Psalm\Type\Atomic;
 use Psalm\Type\Union;
 
+/**
+ * @internal
+ */
 class ArrayCreationInfo
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Assignment/AssignedProperty.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Assignment/AssignedProperty.php
@@ -4,6 +4,9 @@
 
 use Psalm\Type\Union;
 
+/**
+ * @internal
+ */
 class AssignedProperty
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/BitwiseNotAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/BitwiseNotAnalyzer.php
@@ -21,6 +21,9 @@
 use Psalm\Type\Atomic\TString;
 use Psalm\Type\Union;
 
+/**
+ * @internal
+ */
 class BitwiseNotAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/BooleanNotAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/BooleanNotAnalyzer.php
@@ -8,6 +8,9 @@
 use Psalm\Internal\Analyzer\StatementsAnalyzer;
 use Psalm\Type;
 
+/**
+ * @internal
+ */
 class BooleanNotAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/ArgumentMapPopulator.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/ArgumentMapPopulator.php
@@ -18,6 +18,9 @@
 use function substr;
 use function token_get_all;
 
+/**
+ * @internal
+ */
 class ArgumentMapPopulator
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/ClassTemplateParamCollector.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/ClassTemplateParamCollector.php
@@ -16,6 +16,9 @@
 use function array_merge;
 use function array_search;
 
+/**
+ * @internal
+ */
 class ClassTemplateParamCollector
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/AtomicCallContext.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/AtomicCallContext.php
@@ -5,6 +5,9 @@
 use PhpParser;
 use Psalm\Internal\MethodIdentifier;
 
+/**
+ * @internal
+ */
 class AtomicCallContext
 {
     /** @var MethodIdentifier */

diff --git a/...lm/Internal/Analyzer/Statements/Expression/Call/Method/AtomicMethodCallAnalysisResult.php b/...lm/Internal/Analyzer/Statements/Expression/Call/Method/AtomicMethodCallAnalysisResult.php
@@ -5,6 +5,9 @@
 use Psalm\Internal\MethodIdentifier;
 use Psalm\Type\Union;
 
+/**
+ * @internal
+ */
 class AtomicMethodCallAnalysisResult
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/AtomicMethodCallAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/AtomicMethodCallAnalyzer.php
@@ -56,6 +56,8 @@
  * methods.
  *
  * The happy path (i.e 99% of method calls) is handled in ExistingAtomicMethodCallAnalyzer
+ *
+ * @internal
  */
 class AtomicMethodCallAnalyzer extends CallAnalyzer
 {

diff --git a/.../Internal/Analyzer/Statements/Expression/Call/Method/ExistingAtomicMethodCallAnalyzer.php b/.../Internal/Analyzer/Statements/Expression/Call/Method/ExistingAtomicMethodCallAnalyzer.php
@@ -48,6 +48,9 @@
 use function in_array;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class ExistingAtomicMethodCallAnalyzer extends CallAnalyzer
 {
     /**

diff --git a/...alm/Internal/Analyzer/Statements/Expression/Call/Method/MethodCallProhibitionAnalyzer.php b/...alm/Internal/Analyzer/Statements/Expression/Call/Method/MethodCallProhibitionAnalyzer.php
@@ -11,6 +11,9 @@
 use Psalm\Issue\InternalMethod;
 use Psalm\IssueBuffer;
 
+/**
+ * @internal
+ */
 class MethodCallProhibitionAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MethodCallPurityAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MethodCallPurityAnalyzer.php
@@ -19,6 +19,9 @@
 use Psalm\Storage\MethodStorage;
 use Psalm\Type;
 
+/**
+ * @internal
+ */
 class MethodCallPurityAnalyzer
 {
     public static function analyze(

diff --git a/...Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MethodCallReturnTypeFetcher.php b/...Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MethodCallReturnTypeFetcher.php
@@ -34,6 +34,9 @@
 use function in_array;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class MethodCallReturnTypeFetcher
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MethodVisibilityAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MethodVisibilityAnalyzer.php
@@ -17,6 +17,9 @@
 use function end;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class MethodVisibilityAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MissingMethodCallHandler.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Call/Method/MissingMethodCallHandler.php
@@ -25,6 +25,9 @@
 use function array_map;
 use function array_merge;
 
+/**
+ * @internal
+ */
 class MissingMethodCallHandler
 {
     public static function handleMagicMethod(

diff --git a/...lm/Internal/Analyzer/Statements/Expression/Call/StaticMethod/AtomicStaticCallAnalyzer.php b/...lm/Internal/Analyzer/Statements/Expression/Call/StaticMethod/AtomicStaticCallAnalyzer.php
@@ -60,6 +60,9 @@
 use function in_array;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class AtomicStaticCallAnalyzer
 {
     public static function analyze(

diff --git a/...nal/Analyzer/Statements/Expression/Call/StaticMethod/ExistingAtomicStaticCallAnalyzer.php b/...nal/Analyzer/Statements/Expression/Call/StaticMethod/ExistingAtomicStaticCallAnalyzer.php
@@ -44,6 +44,9 @@
 use function strtolower;
 use function substr;
 
+/**
+ * @internal
+ */
 class ExistingAtomicStaticCallAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/CastAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/CastAnalyzer.php
@@ -49,6 +49,9 @@
 use function count;
 use function get_class;
 
+/**
+ * @internal
+ */
 class CastAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/CloneAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/CloneAnalyzer.php
@@ -23,6 +23,9 @@
 use function array_merge;
 use function array_pop;
 
+/**
+ * @internal
+ */
 class CloneAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/EmptyAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/EmptyAnalyzer.php
@@ -11,6 +11,9 @@
 use Psalm\IssueBuffer;
 use Psalm\Type;
 
+/**
+ * @internal
+ */
 class EmptyAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/EncapsulatedStringAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/EncapsulatedStringAnalyzer.php
@@ -16,6 +16,9 @@
 
 use function in_array;
 
+/**
+ * @internal
+ */
 class EncapsulatedStringAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/ExitAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/ExitAnalyzer.php
@@ -21,6 +21,9 @@
 use Psalm\Type\TaintKind;
 use Psalm\Type\Union;
 
+/**
+ * @internal
+ */
 class ExitAnalyzer
 {
     public static function analyze(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/ExpressionIdentifier.php b/src/Psalm/Internal/Analyzer/Statements/Expression/ExpressionIdentifier.php
@@ -14,6 +14,9 @@
 use function is_string;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class ExpressionIdentifier
 {
     public static function getVarId(

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/IncDecExpressionAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/IncDecExpressionAnalyzer.php
@@ -17,6 +17,9 @@
 use Psalm\Node\Scalar\VirtualLNumber;
 use Psalm\Type;
 
+/**
+ * @internal
+ */
 class IncDecExpressionAnalyzer
 {
     /**

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/InstanceofAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/InstanceofAnalyzer.php
@@ -14,6 +14,9 @@
 use function in_array;
 use function strtolower;
 
+/**
+ * @internal
+ */
 class InstanceofAnalyzer
 {
     public static function analyze(