phpdoc - एक विधि

Question

के लिए रिटर्न ऑब्जेक्ट चर परिभाषित करना मैं थोड़ी देर के लिए इस पर खोज कर रहा हूं और या तो मैं सही खोज शब्द का उपयोग नहीं कर रहा हूं या मुझे कुछ याद आ रहा है।

मैं यह पता लगाने की कोशिश कर रहा हूं कि ऑब्जेक्ट द्वारा लौटाए गए चर को परिभाषित करने के लिए PHPdoc का उपयोग करना संभव है या नहीं।

class SomeClass { 
    public function staffDetails($id){ 

     $object = new stdClass(); 
     $object->type = "person"; 
     $object->name = "dave"; 
     $object->age = "46";   

     return $object; 
    } 
} 

अब, यह बहुत आसान इनपुट पैरामीटर परिभाषित करने के लिए है:

मैं निम्नलिखित वर्ग है कहो।

/** 
* Get Staff Member Details 
* 
* @param string $id staff id number 
* 
* @return object 
*/ 

class SomeClass { 
    public function staffDetails($id){ 
     $object = new stdClass(); 
     $object->type = "person"; 
     $object->name = "dave"; 
     $object->age = "46";   

     return $object; 
    } 
} 

सवाल यह है कि वहाँ वस्तु सवाल में विधि द्वारा लौटाए के उत्पादन में चर को परिभाषित ताकि एक और प्रोग्रामर इस वर्ग को खोलने और मैन्युअल रूप से विधि पर गौर क्या देखने के लिए की जरूरत नहीं है के लिए एक समान बात है वापसी वस्तु वापस आ रही है?

Answer 1

यहां 4 साल बाद है, और अभी भी आपके प्रश्न में वर्णित stdClass ऑब्जेक्ट के गुणों को एनोटेट करने का एक तरीका प्रतीत नहीं होता है।

संग्रह PSR-5 में प्रस्तावित किया गया था, लेकिन वह मार गिराया गया प्रतीत होता है: https://github.com/php-fig/fig-standards/blob/211063eed7f4d9b4514b728d7b1810d9b3379dd1/proposed/phpdoc.md#collections

ऐसा लगता है वहाँ केवल दो विकल्प उपलब्ध हैं:

विकल्प 1:

बनाएं एक सामान्य वर्ग आपके डेटा ऑब्जेक्ट का प्रतिनिधित्व करता है और गुणों को एनोटेट करता है।

class MyData 
{ 
    /** 
    * This is the name attribute. 
    * @var string 
    */ 
    public $name; 

    /** 
    * This is the age attribute. 
    * @var integer 
    */ 
    public $age; 
} 

विकल्प 2:

रूप Gordon ने सुझाव दिया एक सामान्य Struct प्रकार वर्ग बनाएँ और अपने डेटा वस्तु के रूप में यह विस्तार, क्या सामान्य मूल्यों __get साथ उपयोग करने के लिए संभव हो रहे हैं परिभाषित करने के लिए @property एनोटेशन का उपयोग कर और __set।

class Struct 
{ 
    /** 
    * Private internal struct attributes 
    * @var array 
    */ 
    private $attributes = []; 

    /** 
    * Set a value 
    * @param string $key 
    * @param mixed $value 
    */ 
    public function __set($key, $value) 
    { 
     $this->attributes[$key] = $value; 
    } 

    /** 
    * Get a value 
    * @param string $key 
    * @return mixed 
    */ 
    public function __get($key) 
    { 
     return isset($this->attributes[$key]) ? $this->attributes[$key] : null; 
    } 

    /** 
    * Check if a key is set 
    * @param string $key 
    * @return boolean 
    */ 
    public function __isset($key) 
    { 
     return isset($this->attributes[$key]) ? true : false; 
    } 
} 

---

/** 
* @property string $name 
* @property integer $age 
*/ 
class MyData extends Struct 
{ 
    // Can optionally add data mutators or utility methods here 
}