psalm/src/Psalm/Checker/InterfaceChecker.php

<?php
namespace Psalm\Checker;

use PhpParser;
use Psalm\StatementsSource;

class InterfaceChecker extends ClassLikeChecker
{
    /**
     * @var array<string, bool>
     */
    protected static $existing_interfaces = [];

    /**
     * @var array<string, bool>
     */
    protected static $existing_interfaces_ci = [];

    /**
     * @param PhpParser\Node\Stmt\ClassLike  $interface
     * @param StatementsSource               $source
     * @param string                         $interface_name
     */
    public function __construct(PhpParser\Node\Stmt\ClassLike $interface, StatementsSource $source, $interface_name)
    {
        if (!$interface instanceof PhpParser\Node\Stmt\Interface_) {
            throw new \InvalidArgumentException('Expecting an interface');
        }

        parent::__construct($interface, $source, $interface_name);

        $storage = self::$storage[$interface_name];

        self::$existing_interfaces[$interface_name] = true;
        self::$existing_interfaces_ci[strtolower($interface_name)] = true;

        if ($interface->extends) {
            foreach ($interface->extends as $extended_interface) {
                $extended_interface_name = self::getFQCLNFromNameObject(
                    $extended_interface,
                    $this->namespace,
                    $this->aliased_classes
                );

                $storage->parent_interfaces[] = $extended_interface_name;
            }
        }
    }

    /**
     * @param  string $interface
     * @return boolean
     */
    public static function interfaceExists($interface)
    {
        if (isset(self::$existing_interfaces_ci[strtolower($interface)])) {
            return self::$existing_interfaces_ci[strtolower($interface)];
        }

        if (in_array($interface, self::$SPECIAL_TYPES)) {
            return false;
        }

        $old_level = error_reporting();
        error_reporting(0);

        $interface_exists = interface_exists($interface, true);

        error_reporting($old_level);

        if ($interface_exists) {
            $reflected_interface = new \ReflectionClass($interface);

            self::$existing_interfaces_ci[strtolower($interface)] = true;
            self::$existing_interfaces[$reflected_interface->getName()] = true;
            return true;
        }

        self::$existing_interfaces_ci[strtolower($interface)] = false;
        self::$existing_interfaces_ci[$interface] = false;

        return false;
    }

    /**
     * @param  string  $interface
     * @return boolean
     */
    public static function hasCorrectCasing($interface)
    {
        if (!self::interfaceExists(strtolower($interface))) {
            throw new \InvalidArgumentException('Cannot check casing on nonexistent class ' . $interface);
        }

        return isset(self::$existing_interfaces[$interface]);
    }

    /**
     * @param  string $interface_name
     * @param  string $possible_parent
     * @return boolean
     */
    public static function interfaceExtends($interface_name, $possible_parent)
    {
        return in_array($possible_parent, self::getParentInterfaces($interface_name));
    }

    /**
     * @param  string $interface_name
     * @return array<string>   all interfaces extended by $interface_name
     */
    public static function getParentInterfaces($interface_name)
    {
        if (self::registerClass($interface_name) === false) {
            throw new \UnexpectedValueException('Cannot deal with unfound file');
        }

        $extended_interfaces = [];

        $storage = self::$storage[$interface_name];

        foreach ($storage->parent_interfaces as $extended_interface_name) {
            $extended_interfaces[] = $extended_interface_name;

            $extended_interfaces = array_merge(
                self::getParentInterfaces($extended_interface_name),
                $extended_interfaces
            );
        }

        return $extended_interfaces;
    }

    /**
     * @return void
     */
    public static function clearCache()
    {
        self::$existing_interfaces = [];
        self::$existing_interfaces_ci = [];
    }
}