Define type for PHPUnit mock objects

Question

I was wondering if phpdoc can be used to define some object in a certain area (only inside the method) as PHPUni Mock, so in this method I can use hints like → expected, → etc., just like when you just create a layout without referring to its real class.

here is a demo:

class someTest extends PHPUnit
{
    // here, usually we define the real class (SomeClass in this example)
    /** @var SomeClass */
    private $someMock;

    public function setUp()
    {
        $this->someMock = $this->getMock(SomeClass::class);
    }

    public function testSomethingInSomeClass()
    {
        // here i expect the type hint i defined in the beginning of this test class and its fine
        $a = $this->someMock->someMethodFromSomeClass();
    }

    private function setSomeMethodOnMock()
    {
        // but here i would like to have the type-hint for phpunit mock object
        // e.g. ->expects,  ->method() , ->willReturn() , etc.
        // if i don't define the mock alias the class type i get will be something like Mock_SomeClass_9873432
        $this->someMock->....
    }
}

Answer 1

/**
 * @var SomeClass|\PHPUnit_Framework_MockObject_MockObject
 */
private $someMock;

You can do the same with the methods:

/**
 * @return SomeClass|\PHPUnit_Framework_MockObject_MockObject
 */
private function getSomeMock()
{
    //....
}