PhpStorm: Type hinting chained methods

Question

In the code snippet below, I get type hinting on $contactInfo[0], and again on $order.

I would like the same with logger, which is an object of type \Monolog\Logger, accessed as a member of \psr\container\ContainerInterface

I am using PhpStorm which is warning me that Field 'logger' not found in Psr\Container\ContainerInterface

/**
 * @param Order $order
 * @param ContactInfo[] $contactInfo
 * @var Monolog\Logger $this->container->logger
 */
private function buildCreateOrderJSON(Order $order, $contactInfo)
{
    try {
        $currentDate = new DateTime();
    } catch (Exception $e) {
        $this->container->logger->addInfo('Some exception', $e->getMessage());
        return;
    }
    $lastName = $contactInfo[0]->getLastName();
    $order->getInvoiceNumber();
}

before going any further : did you use the Jetbrains standard bug-fix method ??? that would be 'file->reindex&restart' — YvesLeBorg
– YvesLeBorg, Commented Jan 8, 2019 at 3:14
If ContainerInterface is own code, try adding a @var declaration in the interface for the logger var. — YvesLeBorg
– YvesLeBorg, Commented Jan 8, 2019 at 3:20
@var Monolog\Logger $this->container->logger -- this is simply wrong as you cannot typehint 3rd level entity like that. PHPDoc and PhpStorm allows typehinting only 1st level — LazyOne
– LazyOne, Commented Jan 8, 2019 at 10:05

e_i_pi · Accepted Answer · 2019-01-10 22:27:26Z

3

As LazyOne mentioned in the comments, you can't type hint a 3rd level entity.

What you can do to retain method name refactoring is you can assign your class element to a variable, then type hint that:

/** @var $logger \Monolog\Logger */
$logger = $this->container->logger;
$logger->addInfo('Some exception', $e->getMessage());

edited Jan 10, 2019 at 22:27

answered Jan 10, 2019 at 22:22

e_i_pi

4,8605 gold badges32 silver badges47 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

JorgeeFG · Accepted Answer · 2019-01-10 22:36:59Z

0

Interfaces cannot have state in PHP, only methods signatures.

For this error to disappear, you can try assigning $this->container to a variable, and type hint that explicitly with a concrete class.

/** @var $container \Some\ConcreteContainerClass */
$container = $this->container;
$container->logger->addInfo('Some exception', $e->getMessage());

This would work if logger is an actual property of that class and not something accessed through magic getters. In that case, you might have to assign logger to another variable and do the same explicit type hint.

Another option is to supress inpesection for that line. https://www.jetbrains.com/help/webstorm/2017.2/suppressing-inspections.html#d218445e68

answered Jan 10, 2019 at 22:36

JorgeeFG

6,06114 gold badges65 silver badges103 bronze badges

Collectives™ on Stack Overflow

PhpStorm: Type hinting chained methods

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related