intellij - PHPStorm: ¿PHPDoc correcto para una colección de objetos?

phpdocumentor download windows

Question

Estoy usando el IDE de PHPStorm y tengo problemas cuando ejecuto la inspección del código.

Tengo un método que devuelve una colección de objetos. La Collection sí misma es un objeto, que tiene sus propios métodos e implementa la interfaz de Traversable :

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

Si documento findByUser() para devolver una Collection , la inspección del código entiende los métodos en este objeto, pero no comprende qué objetos contiene la colección:

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

Si documento findByUser() para devolver una colección de objetos Order , la inspección de código ahora entiende qué hay dentro de la colección, pero no los métodos en la Collection sí:

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

¿Hay alguna manera de especificar ambos al mismo tiempo, algo así como la sintaxis de Java?

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

Answer 1

Puedes combinarlos (ambos tipos) juntos. Puede que no sea ideal en algunas situaciones, pero funciona y puede considerarlo mejor que especificar el tipo manualmente a través del comentario @var PHPDoc.

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