Cách ghi lại các phương thức magic (_call và _callStatic) cho IDE

Sau nhiều năm vui vẻ viết mã bằng notepad ++ và tuyệt vời, tôi đã được khuyên nên sử dụng PHP IDE. Tôi đang thử phpStorm và nó có vẻ tốt. Hoàn thành mã và tài liệu là một tính năng tuyệt vời nhưng không hoạt động với tôi khi các phương pháp ma thuật được sử dụng. Có một công việc xung quanh để có được phpStorm để hiểu những gì đang xảy ra trong các phương pháp ma thuật?

Tình huống của chúng tôi là như thế này:

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();

Phương thức callStatic ma thuật cho phép chúng ta lấy một tập hợp các đối tượng thông qua 1 hoặc nhiều đối số tạo nên lời gọi hàm.

Tôi thấy rằng có một câu lệnh @method để sử dụng trong những trường hợp này nhưng phpStorm chỉ chọn câu lệnh đầu tiên trong số những câu lệnh này. Hơn nữa, tôi chỉ có thể đặt kiểu trả về thành hỗn hợp ở nơi mà tôi muốn có thể đặt nó thành bất kỳ lớp nào mà nó được gọi (b trong ví dụ của tôi).

Bất kỳ ý tưởng hoặc đề xuất sẽ được nhận rất biết ơn, cảm ơn.

Sử dụng nhận xét PHPDoc cấp lớp - cụ thể là thẻ @method - hoạt động tốt trong PhpStorm:

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

Ở trên:

• @method - Thẻ PHPDoc
• static - nói rằng đây là phương thức tĩnh
• someClasshoặc $this- loại trả lại
• get_by_user_id - tên phương thức
• (int $id) - chữ ký phương thức: ([[type] [parameter]<, ...>])
• Bla-bla - một số mô tả tùy chọn

Thông tin thêm về @method:

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

PS Mặc dù @method statichoạt động tốt trong PhpStorm (cho IDE biết rằng phương thức là tĩnh), nó có thể chưa được hỗ trợ bởi công cụ phpDocumentor thực tế (xin lỗi, đã không sử dụng nó một thời gian).

Ngoài ra : (tất nhiên là trong PhpStorm) Settings | Inspections | PHP | Undefined | Undefined method --> Downgrade severity if __magic methods are present in class- nó sẽ không giúp hoàn thành mã cho các phương thức như vậy theo bất kỳ cách nào, nhưng sẽ không đánh dấu các phương thức ma thuật đó là lỗi "phương thức không xác định".

Phiếu của phpDocumentor về việc sử dụng RegEx / một phần tên cho @property/ @methodthẻ (nó có thể hữu ích như thế nào đối với tài liệu và nó có thể mang lại ít trợ giúp như thế nào cho IDE thực tế khi xử lý hoàn thành mã):

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

Hơi liên quan đến câu hỏi ban đầu:

Bạn cũng có thể xác định điều này trong tệp meta phpstorm. Dưới đây là một ví dụ cho phương pháp nhà máy (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();

Bằng cách này, bạn không phải khóa mọi khả năng khi phép thuật xảy ra.

Có một số tài liệu để biết chi tiết.