आईडीई के लिए जादू (_call और _callStatic) विधियों का दस्तावेज कैसे करें

Question 1

नोटपैड ++ और उदात्त में कोडिंग के कई खुश वर्षों के बाद, मुझे सलाह दी गई है कि मुझे एक पीएचपी आईडीई दिया जाए। मैं 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();

मैजिक कॉलस्टैटिक विधि हमें 1 या अधिक तर्कों के माध्यम से वस्तुओं का एक संग्रह प्राप्त करने की अनुमति देती है जो फ़ंक्शन कॉल करती हैं।

मैं देख रहा हूं कि इन मामलों में उपयोग के लिए @method बयान है लेकिन phpStorm केवल इन बयानों में से सबसे पहले उठा रहा है। इसके अलावा मैं केवल मिश्रित प्रकार को मिश्रित करने के लिए सेट कर सकता हूं, जहां मैं इसे सेट करने में सक्षम होना चाहूंगा क्योंकि इसे जिस भी वर्ग पर बुलाया गया था (मेरे उदाहरण में बी)।

कोई भी विचार या सुझाव बहुत आभार प्राप्त होगा, धन्यवाद।

Question 2

वर्ग-स्तरीय 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:

PS जबकि @method staticPhpStorm में ठीक काम करता है (IDE बताता है कि यह विधि स्थिर है) यह वास्तविक phpDocumentor टूल द्वारा समर्थित (अभी तक?) नहीं हो सकता है (क्षमा करें, कुछ समय के लिए इसका उपयोग नहीं किया है)।

वैकल्पिक रूप से : (PhpStorm में, निश्चित रूप से) Settings | Inspections | PHP | Undefined | Undefined method --> Downgrade severity if __magic methods are present in class- यह किसी भी तरह से इस तरह के तरीकों के लिए कोड पूरा करने में मदद नहीं करेगा, लेकिन उन जादुई तरीकों को "अपरिभाषित विधि" त्रुटियों के रूप में चिह्नित नहीं करेगा।

RegEx / आंशिक नाम @property/ @methodटैग के लिए (यह प्रलेखन के लिए कैसे उपयोगी हो सकता है और कोड पूरा होने के दौरान वास्तविक IDE को लाने में कितनी मदद कर सकता है) का उपयोग करने के बारे में phpDocumentor का टिकट :

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

Question 3

मूल प्रश्न से थोड़ा संबंधित:

आप इसे 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();

इस तरह से आपको जादू होने पर हर संभावना को रोकना नहीं है।

विवरण के लिए कुछ डॉक्स रखें ।