Merge pull request #7420 from orklah/remove-old-things

Remove forbidEcho
vimeo · Jan 19, 2022 · 5a6dccd · 5a6dccd
2 parents 4e57110 + ddf7a0b
commit 5a6dccd
Show file tree

Hide file tree

Showing 10 changed files with 3 additions and 73 deletions.
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -131,6 +131,7 @@
  - [BC] Method `Psalm\Type\Union::isEmpty()` was removed
  - [BC] Property `Psalm\Config::$allow_phpstorm_generics` was removed
  - [BC] Property `Psalm\Config::$exit_functions` was removed
+ - [BC] Property `Psalm\Config::$forbid_echo` was removed
  - [BC] Method `Psalm\Type::getEmpty()` was removed
  - [BC] Legacy hook interfaces have been removed:
    -  `Psalm\Plugin\Hook\MethodReturnTypeProviderInterface`

diff --git a/config.xsd b/config.xsd
@@ -41,13 +41,6 @@
         <xs:attribute name="findUnusedCode" type="xs:boolean" default="false" />
         <xs:attribute name="findUnusedVariablesAndParams" type="xs:boolean" default="false" />
         <xs:attribute name="findUnusedPsalmSuppress" type="xs:boolean" default="false" />
-        <xs:attribute name="forbidEcho" type="xs:boolean" default="false">
-            <xs:annotation>
-                <xs:documentation xml:lang="en">
-                    Deprecated. Will be replaced by adding echo to forbiddenFunctions in Psalm 5.
-                </xs:documentation>
-            </xs:annotation>
-        </xs:attribute>
         <xs:attribute name="hideExternalErrors" type="xs:boolean" default="false" />
         <xs:attribute name="hoistConstants" type="xs:boolean" default="false" />
         <xs:attribute name="ignoreInternalFunctionFalseReturn" type="xs:boolean" default="true" />
@@ -233,7 +226,6 @@
             <xs:element name="FalsableReturnStatement" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="FalseOperand" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="ForbiddenCode" type="IssueHandlerType" minOccurs="0" />
-            <xs:element name="ForbiddenEcho" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="IfThisIsMismatch" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="ImplementationRequirementViolation" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="ImplementedParamTypeMismatch" type="IssueHandlerType" minOccurs="0" />

diff --git a/docs/running_psalm/error_levels.md b/docs/running_psalm/error_levels.md
@@ -284,7 +284,6 @@ These issues are treated as errors at level 7 and below.
 
 ## Feature-specific errors
 
- - [ForbiddenEcho](issues/ForbiddenEcho.md)
  - [PossiblyUndefinedIntArrayOffset](issues/PossiblyUndefinedIntArrayOffset.md)
  - [PossiblyUndefinedStringArrayOffset](issues/PossiblyUndefinedStringArrayOffset.md)
  - [PossiblyUnusedMethod](issues/PossiblyUnusedMethod.md)

diff --git a/docs/running_psalm/issues.md b/docs/running_psalm/issues.md
@@ -32,7 +32,6 @@
  - [FalsableReturnStatement](issues/FalsableReturnStatement.md)
  - [FalseOperand](issues/FalseOperand.md)
  - [ForbiddenCode](issues/ForbiddenCode.md)
- - [ForbiddenEcho](issues/ForbiddenEcho.md)
  - [IfThisIsMismatch](issues/IfThisIsMismatch.md)
  - [ImplementationRequirementViolation](issues/ImplementationRequirementViolation.md)
  - [ImplementedParamTypeMismatch](issues/ImplementedParamTypeMismatch.md)

diff --git a/docs/running_psalm/issues/ForbiddenEcho.md b/docs/running_psalm/issues/ForbiddenEcho.md
diff --git a/src/Psalm/Config.php b/src/Psalm/Config.php
@@ -424,11 +424,6 @@ class Config
      */
     public $forbidden_functions = [];
 
-    /**
-     * @var bool
-     */
-    public $forbid_echo = false;
-
     /**
      * @var bool
      */
@@ -919,7 +914,6 @@ private static function fromXmlAndPaths(
             'addParamDefaultToDocblockType' => 'add_param_default_to_docblock_type',
             'checkForThrowsDocblock' => 'check_for_throws_docblock',
             'checkForThrowsInGlobalScope' => 'check_for_throws_in_global_scope',
-            'forbidEcho' => 'forbid_echo',
             'ignoreInternalFunctionFalseReturn' => 'ignore_internal_falsable_issues',
             'ignoreInternalFunctionNullReturn' => 'ignore_internal_nullable_issues',
             'includePhpVersionsInErrorBaseline' => 'include_php_versions_in_error_baseline',

diff --git a/src/Psalm/Internal/Analyzer/Statements/EchoAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/EchoAnalyzer.php
@@ -12,7 +12,6 @@
 use Psalm\Internal\Codebase\TaintFlowGraph;
 use Psalm\Internal\DataFlow\TaintSink;
 use Psalm\Issue\ForbiddenCode;
-use Psalm\Issue\ForbiddenEcho;
 use Psalm\Issue\ImpureFunctionCall;
 use Psalm\IssueBuffer;
 use Psalm\Storage\FunctionLikeParameter;
@@ -96,17 +95,7 @@ public static function analyze(
             }
         }
 
-        if ($codebase->config->forbid_echo) {
-            if (IssueBuffer::accepts(
-                new ForbiddenEcho(
-                    'Use of echo',
-                    new CodeLocation($statements_analyzer, $stmt)
-                ),
-                $statements_analyzer->getSource()->getSuppressedIssues()
-            )) {
-                return false;
-            }
-        } elseif (isset($codebase->config->forbidden_functions['echo'])) {
+        if (isset($codebase->config->forbidden_functions['echo'])) {
             IssueBuffer::maybeAdd(
                 new ForbiddenCode(
                     'Use of echo',

diff --git a/src/Psalm/Issue/ForbiddenEcho.php b/src/Psalm/Issue/ForbiddenEcho.php
diff --git a/tests/DocumentationTest.php b/tests/DocumentationTest.php
@@ -277,9 +277,6 @@ public function providerInvalidCodeParse(): array
                 case 'InvalidStringClass':
                     continue 2;
 
-                case 'ForbiddenEcho':
-                    continue 2;
-
                 case 'PluginClass':
                     continue 2;
 

diff --git a/tests/ForbiddenCodeTest.php b/tests/ForbiddenCodeTest.php
@@ -97,7 +97,7 @@ public function testAllowedEchoFunction(): void
         $this->analyzeFile($file_path, new Context());
     }
 
-    public function testForbiddenEchoFunctionViaFunctions(): void
+    public function testForbiddenCodeFunctionViaFunctions(): void
     {
         $this->expectExceptionMessage('ForbiddenCode');
         $this->expectException(CodeException::class);
@@ -124,29 +124,6 @@ public function testForbiddenEchoFunctionViaFunctions(): void
         $this->analyzeFile($file_path, new Context());
     }
 
-    public function testForbiddenEchoFunctionViaFlag(): void
-    {
-        $this->expectExceptionMessage('ForbiddenEcho');
-        $this->expectException(CodeException::class);
-        $this->project_analyzer = $this->getProjectAnalyzerWithConfig(
-            TestConfig::loadFromXML(
-                dirname(__DIR__, 2),
-                '<?xml version="1.0"?>
-                <psalm forbidEcho="true"></psalm>'
-            )
-        );
-
-        $file_path = getcwd() . '/src/somefile.php';
-
-        $this->addFile(
-            $file_path,
-            '<?php
-                echo "hello";'
-        );
-
-        $this->analyzeFile($file_path, new Context());
-    }
-
     public function testAllowedPrintFunction(): void
     {
         $this->project_analyzer = $this->getProjectAnalyzerWithConfig(