Autouzupełnianie PhpStorm w cechach

Question

Mam cechę, która musi zawsze być mieszana z podklasą \PHPUnit_Framework_TestCase. PhpStorm tego nie wie. Czy jest coś, co mogę zrobić, aby PhpStorm automatycznie się uzupełniał i "typecheckował" takie rzeczy jak assertNull wewnątrz cechy?

<?php 
trait MyTestUtils 
{ 
    public function foo() 
    { 
     $this->assertNu // autocomplete? 
    } 
} 

Najlepszym mogę wymyślić tak daleko jest wprowadzenie następujących w każdej metody:

/** @var \PHPUnit_Framework_TestCase|MyTestUtils $this */ 

Ale to jest powtarzalne i nie rozumie chronione memebers. Czy jest lepsza opcja?

Answer 1

Twierdzę, że nie jest to poprawny przypadek użycia dla cechy PHP. Twoja cecha, jak napisano, nie jest gwarantowana tylko dla klas rozszerzających \ PHPUnit_Framework_TestCase. To wprowadza bardzo ściśle powiązany kod. Najlepszą praktyką Cechu jest to, że są bardzo luźno powiązani i mają tylko świadomość własnej zawartości.

bym zamiast tego zaleca się albo:

1. utworzyć podklasę \ PHPUnit_Framework_TestCase że wasze przypadki testowe, które potrzebują tej funkcjonalności mogą przedłużyć
2. tworzenia niestandardowych klas twierdzenie. Te mogą być wielokrotnie używane do robienia grup niestandardowych asercji.

Obie techniki są opisane tutaj: http://phpunit.de/manual/4.1/en/extending-phpunit.html

Są dwa zalecane najlepsze praktyki, gdzie umieścić metod pomocniczych, takich jak te.

Answer 2

Poza pomocą bloku dokumentacyjnym php udokumentować $this, tylko inny sposób jestem świadomy, co również sprawia, że ​​prawdopodobnie cecha bardziej „bezpieczny” w każdym razie, jest zdefiniowanie metody abstrakcyjne na samej cechy, np:

trait F { 

    /** 
    * @return string[] 
    */ 
    abstract public function Foo(); 

    /** 
    * @return self 
    */ 
    abstract public function Bar(); 
} 

abstract class Bar { 
    use F; 

    /** 
    * @return bool|string[] 
    */ 
    public function Baz() { 
     if ($this->Bar()) { 
      return $this->Foo(); 
     } 

     return false; 
    } 
} 

Answer 3

UPDATE: od PhpStorm 2016.1.2 (build 145.1616) autocompletion w cechach działa out-of-the-box. Jest wystarczająco inteligentny, aby dowiedzieć się, jakie klasy używają tej cechy, a następnie zapewnić autouzupełnianie. Link do tej kwestii: https://youtrack.jetbrains.com/issue/WI-16368

Wcześniej odpowiedział:

Można użyć:

@method \PHPUnit_Framework_TestCase assertTrue($condition, $message = '') 

... w bloku dokumentacyjnym samej cechy, ale minusem jest to, że trzeba wstawić @method dla każdej metody, która ma być autouzupełniania, co nie jest złe, jeśli używasz normalnej liczby wywołań metod w swojej funkcji. Lub "udokumentuj" tylko te metody, z których najczęściej korzystasz.