doctrine / persistence

FindClassMethodUsagesPlugin.php

<?php

namespace UsageFinder;

use PhpParser\Node\Expr;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use Psalm\CodeLocation;

The type Psalm\CodeLocation was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\Codebase;

The type Psalm\Codebase was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\Context;

The type Psalm\Context was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\FileManipulation;

The type Psalm\FileManipulation was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\IssueBuffer;

The type Psalm\IssueBuffer was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\Issue\PluginIssue;

The type Psalm\Issue\PluginIssue was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\Plugin\Hook\AfterMethodCallAnalysisInterface;

The type Psalm\Plugin\Hook\AfterMethodCallAnalysisInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\StatementsSource;

The type Psalm\StatementsSource was not found. Maybe you did not declare it correctly or list all dependencies?

use Psalm\Type\Union;

The type Psalm\Type\Union was not found. Maybe you did not declare it correctly or list all dependencies?

use UsageFinder\ClassMethodReference;

The type UsageFinder\ClassMethodReference was not found. Maybe you did not declare it correctly or list all dependencies?

use UsageFinder\Issue\ClassMethodUsageFound;

The type UsageFinder\Issue\ClassMethodUsageFound was not found. Maybe you did not declare it correctly or list all dependencies?

final class FindClassMethodUsagesPlugin implements AfterMethodCallAnalysisInterface
{
    /** @var ClassMethodReference */
    public static $classMethodReference;

    public static function afterMethodCallAnalysis(
        Expr $expr,
        string $method_id,
        string $appearing_method_id,
        string $declaring_method_id,
        Context $context,
        StatementsSource $statements_source,
        Codebase $codebase,
        array &$file_replacements = [],
        Union &$return_type_candidate = null
    ) {
        if (!self::isMethodWeWant($declaring_method_id, $codebase)) {
            return;
        }

        $message = sprintf("Found reference to %s\n",
            self::getFindName()
        );

        if (IssueBuffer::accepts(
            new ClassMethodUsageFound(
                $message,
                new CodeLocation($statements_source, $expr->name)
            ),
            $statements_source->getSuppressedIssues()
        )) {
            // fall through
        }
    }

    private static function isMethodWeWant(string $declaring_method_id, Codebase $codebase) : bool
    {
        list($className, $methodName) = explode('::', $declaring_method_id);

        if ($declaring_method_id === self::getFindName()) {
            return true;
        }

        if ($methodName === self::getFindMethodName()
            && $codebase->classImplements($className, self::getFindClassName())) {
            return true;
        }

        return false;
    }

    private static function getFindName() : string
    {
        return 'Doctrine\Common\Collections\Collection::slice';

        // return self::$classMethodReference->getName();
    }

    private static function getFindClassName() : string
    {
        return 'Doctrine\Common\Collections\Collection';

        // return self::$classMethodReference->getClassName();
    }

    private static function getFindMethodName() : string
    {
        return 'slice';

        // self::$classMethodReference->getMethodName()
    }
}