PHPdoc - 为 stdClass 的对象定义对象属性

php code-documentation phpdoc

2022-08-30 17:51:11

我试图弄清楚是否可以使用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;
    }
}

问题是，对于定义由相关方法返回的输出对象（stdClass）的属性，是否存在类似的事情。这样另一个程序员就不必打开这个类并手动查看该方法以查看返回对象返回的内容？

答案 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 的建议创建一个泛型类型类，并将其扩展为数据对象，使用 @property 注释定义可以使用和访问哪些泛型值。Struct__get__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
}

答案 2

您只有两种方法可以记录结果类的结构。

1.可以在注释文本中描述结构。例如：

class SomeClass 
{
    /**
     * Getting staff detail.
     * Result object has following structure:
     * <code>
     * $type - person type
     * $name - person name
     * $age - person age
     * </code>
     * @param string $id staff id number
     *
     * @return stdClass
     *
     */
    public function staffDetails($id){
        $object = new stdClass();
        $object->type = "person";
        $object->name = "dave";
        $object->age = "46";
        return $object;
    }
}

2.可以创建一个将继承stdClass的数据类型，它将具有结果对象的注释。例如：

/**
 * @property string $type Person type
 * @property string $name Person name
 * @property integer $age Person age
 */
class DTO extends stdClass
{}

并在其他类中使用它

class SomeClass {

    /**
     * Getting staff detail.
     *
     * @param string $id staff id number
     *
     * @return DTO
     *
     */
    public function staffDetails($id){

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

        return $object;
    }
}

在我看来，这种方式比文本注释中的描述更好，因为它使代码更加明显。