如何记录 IDE 的魔法（__call 和 __callStatic）方法

Question

在使用 notepad++ 和 sublime 编码多年后，有人建议我试一试 PHP IDE。我正在尝试 phpStorm，它看起来不错。代码完成和文档是一个很棒的功能，但在使用魔术方法时对我来说不起作用。 有没有办法让 phpStorm 了解魔术方法中发生了什么？

我们的情况是这样的：

abstract class a {
    public static function __callStatic($method,$args)
    {
        if(strpos($method,"get_by_") === 0)
        {
            //do stuff
        } elseif(strpos($method,"get_first_by_") === 0) {
            //do stuff
        } elseif($method == "get_all") {
            //do stuff
        }
    }
}

class b extends a {
    // some more stuff
}

b::get_by_user_id(27);
b::get_first_by_id(156);
b::get_all();

神奇的 callStatic 方法允许我们通过构成函数调用的 1 个或多个参数来获取对象集合。

我看到在这些情况下有一个@method 语句可以使用，但是 phpStorm 只选择了这些语句中的第一个。此外，我只能将返回类型设置为混合，因为我希望能够将其设置为调用它的任何类（在我的示例中为 b）。

任何想法或建议都将非常感激，谢谢。

Answer 1

使用类级别的 PHPDoc 注释——特别是 @method 标签——在 PhpStorm 中可以正常工作：

/**
 * @method static someClass get_by_user_id(int $id) Bla-bla
 * @method static someClass get_first_by_id(int $id) 
 */
abstract class a {
...

在上面：

• @method -- PHPDoc 标签
• static -- 表示这是静态方法
• someClass 或 $this -- 返回类型
• get_by_user_id -- 方法名
• (int $id) -- 方法签名：([[type] [parameter]<, ...>])
• Bla-bla -- 一些可选描述

更多关于@method：

• https://docs.phpdoc.org/latest/references/phpdoc/tags/method.html
• https://github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md#711-method

附言 虽然@method static 在 PhpStorm 中运行良好（告诉 IDE 该方法是静态的），但实际的 phpDocumentor 工具可能（还没有？）支持它（抱歉，暂时没有使用它）。

---

或者：（当然是在 PhpStorm 中）Settings | Inspections | PHP | Undefined | Undefined method --> Downgrade severity if __magic methods are present in class -- 它不会以任何方式帮助此类方法的代码完成，但不会将这些魔术方法标记为“未定义方法”错误。

---

phpDocumentor's ticket 关于为 @property/@method 标记使用 RegEx/部分名称（它对文档有多大用处，以及在处理代码时它对实际 IDE 的帮助有多大）完成）：

• https://github.com/phpDocumentor/phpDocumentor2/issues/689

Answer 2

与原始问题有些相关：

您也可以在 phpstorm 元文件中定义它。这是工厂方法（v2016.3）的示例：

// Define in .phpstorm.meta.php
namespace PHPSTORM_META {
    $STATIC_METHOD_TYPES = [
        \Factory::create('') => [],
    ];
}

// Then use in code
$factory = new \Factory();
$user = $factory->create(\User::class);
// Here you get autocomplete.
$user->subscribe();

这样，当魔法发生时，您不必在文档中阻止所有可能性。

有一些docs了解详情。