Исправить ошибку подсказки типа, выданную PHPStan на UserInterface в проекте Symfony - PullRequest
Новая
       118

Исправить ошибку подсказки типа, выданную PHPStan на UserInterface в проекте Symfony

0 голосов
/ 29 апреля 2020

Я недавно начал использовать PHPStan (версия 0.12.19) в проекте Symfony 3.4 , но я получаю сообщение об ошибке, которое кажется простым чтобы решить, но я изо всех сил пытаюсь выяснить.

В настоящее время работает на уровне 7. Вот ошибка, которую я получаю при запуске:

vendor/bin/phpstan analyse

------ --------------------------------------------------------------------------------------------------------------
  Line   src/AppBundle/Controller/MapController.php
 ------ --------------------------------------------------------------------------------------------------------------
  94     Parameter #1 $user of static method AppBundle\Entity\MapMarker::createMapMarker() expects
         Symfony\Component\Security\Core\User\UserInterface, object given.

Это важные части MapController. php: 

    $user = $this->getUser();

     $mapMarker = MapMarker::createMapMarker(
            $user,
            $latitude,
            $longitude
        );

Метод getUser - Symfony, поэтому я не могу изменить эту часть: https://github.com/symfony/symfony/blob/3.4/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php#L444: 

/**
     * Get a user from the Security Token Storage.
     *
     * @return UserInterface|object|null
     *
     * @throws \LogicException If SecurityBundle is not available
     *
     * @see TokenInterface::getUser()
     *
     * @final since version 3.4
     */
    protected function getUser()
    {
        if (!$this->container->has('security.token_storage')) {
            throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
        }

        if (null === $token = $this->container->get('security.token_storage')->getToken()) {
            return null;
        }

        if (!\is_object($user = $token->getUser())) {
            // e.g. anonymous authentication
            return null;
        }

        return $user;
    }

И важные части MapMarker. php: 

/**
     * @param UserInterface $user
     * @param double $latitude
     * @param double $longitude
     */
    private function __construct(UserInterface $user, $latitude, $longitude) {
        $this->createdBy = $user;
        $this->latitude = $latitude;
        $this->longitude = $longitude;
    }

    /**
     * @param UserInterface $user
     * @param double $latitude
     * @param double $longitude
     * @return MapMarker
     */
    public static function createMapMarker(UserInterface $user, $latitude, $longitude): MapMarker
    {
        return new self($user, $latitude, $longitude);
    }

Когда я выкидываю $user instanceof UserInterface, он возвращает true - насколько я могу судить, он передает объект UserInterface, а не просто «объект», как указывает PHPStan.

И, наконец, вот мой файл конфигурации phpstan.neon: 

parameters:
    level: 7
    paths:
        - src
        - tests
    checkGenericClassInNonGenericObjectType: false
    checkMissingIterableValueType: false

Чего мне не хватает?

1 Ответ

1 голос
/ 29 апреля 2020

Я думаю, что вы, по крайней мере, поняли, в чем проблема: тип возврата метода getUser равен @return UserInterface|object|null, в то время как createMapMarker ожидает экземпляр UserInterface.

Перед вызовом createMapMarker вы следует проверить, что возвращаемое значение getUser на самом деле является экземпляром UserInterface и, вероятно, простое /** @var UserInterface $user */ прямо поверх него исправит объявление переменной $user.

...