PHPDoc and Methods Anonymous functions

Question

I am trying to solve an annoying problem with PhpStorm's code validation when it comes to anonymous function. It does not see the passed object's methods.

The code snippet below relies on Predis and the pipeline method.

startCacheClient()

Instantiates and returns an instance of predis.

pipeline()

validates as it should, however

$pipe-set() and $pipe->expire()

Fail to validate and returns "Method 'Set' Not Found in" and "Method 'Expire' Not Found in"

    $this->i = 0;
    $this->startCacheClient()->pipeline(function($pipe) use($values, $jsonEncode, $keepAlive){

        foreach($values as $key => $currentValue){

            if($jsonEncode) {
                $currentValue = gzcompress(json_encode($currentValue), -1);
            }

            $pipe->set($key, $currentValue);
            $pipe->expire($key, $keepAlive);

            $this->i++;
        }
    });

How can I get PhpStorm through PHPDoc to understand that these methods are actually there and available. The code functions as expected, but validation notice is annoying.

In case if you need an actual PHPDoc solution: /** @var \Predis\ClientContextInterface $pipe */ -- place such line somewhere inside the anonymous function (e.g. just after function body is started -- before any of the code -- before foreach statement in your original code sample) -- should work (not 100% sure though). — LazyOne
– LazyOne, Commented Sep 1, 2016 at 10:45

SeaFuzz · Accepted Answer · 2016-09-01 03:04:08Z

4

If $pipe is an instance of \Predis\Pipeline\Pipeline, then you could type hint within the anonymous function declaration like:

$this->startCacheClient()->pipeline(function(\Predis\ClientContextInterface $pipe) use($values, $jsonEncode, $keepAlive){
    /* DO STUFF HERE */
});

edited Sep 1, 2016 at 3:04

SeaFuzz

1,2372 gold badges11 silver badges28 bronze badges

answered Sep 1, 2016 at 2:15

segFault

4,0541 gold badge21 silver badges34 bronze badges

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

1 Comment

SeaFuzz Over a year ago

That did it! Why I didn't think of that, I will never know. Thanks for the help. Ended up pointing to the interface. I updated your code snippet to show the final implementation.

Collectives™ on Stack Overflow

PHPDoc and Methods Anonymous functions

1 Answer 1

1 Comment

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Related