How to fix an error about PHPDoc on interface class

Question

I'm working on a PHP library and I have two classes.

First one is like this:

/**
 * @method static A getInstance()
 */
interface A {...}

Second one is like this:

class B implements A {...}

getInstance is not defined in A, except in PHPDoc above class. Now, my IDE (PHPStorm) suggests an error, saying that I should implement getInstance in B.

My questions are:

Why they put this method in PHPDoc even though it's not declared in the interface? I doubt it's a mistake, since they used the same comment in many other classes.
What do you recommend? should I implement in B or should I remove the PHPDoc comment from A?

Can you attach a link to the library that contains interface A? — Maksym Fedorov
– Maksym Fedorov, Commented Jan 16, 2019 at 8:27
@MaximFedorov Of course. Here: github.com/oxwall/oxwall/blob/… — Moradnejad
– Moradnejad, Commented Jan 16, 2019 at 8:28

Maksym Fedorov · Accepted Answer · 2019-01-16 09:44:52Z

1

I think it's the mistake because any of the classes which implement OW_Storage interface don't implement getInstance() method. You can make sure it with help search. It means this function isn't used.

You can remove the doc block from the interface but right way is to do pull-request in origin repository.

edited Jan 16, 2019 at 9:44

answered Jan 16, 2019 at 9:03

Maksym Fedorov

6,4462 gold badges13 silver badges31 bronze badges

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

Collectives™ on Stack Overflow

How to fix an error about PHPDoc on interface class

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related