php - PHPStorm:オブジェクトのコレクションのPHPDocを修正しますか?

Question

PHPStorm IDEを使用していますが、コードインスペクションを実行すると問題が発生します。

オブジェクトのコレクションを返すメソッドがあります。Collection自体は、独自のメソッドを持ち、Traversableインターフェースを実装するオブジェクトです。

class Repository
{
    public function findByCustomer(Customer $user)
    {
        // ...
        return new Collection($orders);
    }
}

findByUser()を返すように文書化するCollectionと、コードインスペクションはこのオブジェクトのメソッドを理解しますが、コレクションに含まれるオブジェクトを理解できません。

/**
 * @return Collection
 */
public function findByCustomer() { ... }

メソッド getTotal() がクラス Collection に見つかりません

findByUser()オブジェクトのコレクションを返すように文書化するOrderと、コードインスペクションはコレクションの内容を理解するようになりましたが、Collectionそれ自体のメソッドは理解できません。

/**
 * @return Order[]
 */
public function findByCustomer() { ... }

クラス Order[] にメソッド slice() が見つかりません

Javaの構文のように、両方を同時に指定する方法はありますか?

/**
 * @return Collection<Order>
 */
public function findByCustomer() { ... }

score 63 · Accepted Answer

それら（両方のタイプ）を一緒に組み合わせることができます。@var状況によっては理想的ではないかもしれませんが、動作し、 PHPDoc コメントを介して手動でタイプを指定するよりも優れていると考えることができます。

/** @return Collection|Order[] */

score 12 · Accepted Answer

2021.2 以降の Phpstorm では、次の構文が使用できます。

/**
 * @return Collection<Order>
 */

PhpStorm の新機能 2021.2 のスクリーンショット:

2 に答える 2