如何指定 PHPDoc 中继承方法返回的对象类型？

Question

假设我有这个抽象的数据库表类：

abstract class DbTable {
    /**
     * Table records
     * @var DatabaseRecordIF[] 
     */
   protected $records;

   /**
    * Returns the records.
    * @return DatabaseRecordIf[]
    */
   public function getRecords() {
       return $this->records;
   }
}

我有一个特定的数据库表类来存储表中的记录：

class MyTable extends DbTable { }

我有一个类在该表中定义了一条记录：

class MyTableRecord implements DatabaseRecordIf { }

我想告诉 phpDocumentor MyTable::getRecords() 返回 MyTableRecord[]，而不仅仅是 DatabaseRecordIf[]。这可能吗？

有没有更好的方法来解决这个问题？

Answer 1

phpDocumentor 定义了static 和self 用于指定继承方法返回的类型。

self 使用此类型的类的对象，如果继承它仍将代表最初定义它的类。

static 使用此值的类的对象，如果继承它将代表子类。 （参见 PHP 手册中的后期静态绑定）。

所以 static 是您需要返回子类型而不是父类型的类型。

   /**
    * Returns the records.
    * @return static[]
    */
   public function getRecords() {
       return $this->records;
   }