StubTrait.md

Codeception\Test\Feature\Stub

Usage in Codeception

Since Codeception 2.3.8 this trait is enabled in \Codeception\Test\Unit class.

Usage in PHPUnit

Include this trait into a TestCase to be able to use Stubs and Mocks:

<?php
class MyTest extends \PHPUnit\Framework\TestCase
{
     use Codeception\Test\Feature\Stub;
}

public make($class, array $params = Array ( ) )

Instantiates a class without executing a constructor. Properties and methods can be set as a second parameter. Even protected and private properties can be set.

<?php
$this->make('User');
$this->make('User', ['name' => 'davert']);

Accepts either name of class or object of that class

<?php
$this->make(new User, ['name' => 'davert']);

To replace method provide it's name as a key in second parameter and it's return value or callback function as parameter

<?php
$this->make('User', ['save' => function () { return true; }]);
$this->make('User', ['save' => true]);

• template RealInstanceType of object

• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked

• param array $params - properties and methods to set

• return MockObject&RealInstanceType - mock

• throws RuntimeException when class does not exist

• throws Exception

public makeEmpty($class, array $params = Array ( ) )

Instantiates class having all methods replaced with dummies. Constructor is not triggered. Properties and methods can be set as a second parameter. Even protected and private properties can be set.

<?php
$this->makeEmpty('User');
$this->makeEmpty('User', ['name' => 'davert']);

Accepts either name of class or object of that class

<?php
$this->makeEmpty(new User, ['name' => 'davert']);

To replace method provide it's name as a key in second parameter and it's return value or callback function as parameter

<?php
$this->makeEmpty('User', ['save' => function () { return true; }]);
$this->makeEmpty('User', ['save' => true]);

• template RealInstanceType of object
• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked
• param array $params
• return MockObject&RealInstanceType
• throws Exception

public makeEmptyExcept($class, $method, array $params = Array ( ) )

Instantiates class having all methods replaced with dummies except one. Constructor is not triggered. Properties and methods can be replaced. Even protected and private properties can be set.

<?php
$this->makeEmptyExcept('User', 'save');
$this->makeEmptyExcept('User', 'save', ['name' => 'davert']);

Accepts either name of class or object of that class

<?php
* $this->makeEmptyExcept(new User, 'save');

To replace method provide it's name as a key in second parameter and it's return value or callback function as parameter

<?php
$this->makeEmptyExcept('User', 'save', ['isValid' => function () { return true; }]);
$this->makeEmptyExcept('User', 'save', ['isValid' => true]);

• template RealInstanceType of object

• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked

• return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType

• throws Exception

public construct($class, array $constructorParams = Array ( ) , array $params = Array ( ) )

Instantiates a class instance by running constructor. Parameters for constructor passed as second argument Properties and methods can be set in third argument. Even protected and private properties can be set.

<?php
$this->construct('User', ['autosave' => false]);
$this->construct('User', ['autosave' => false], ['name' => 'davert']);

Accepts either name of class or object of that class

<?php
$this->construct(new User, ['autosave' => false), ['name' => 'davert']);

To replace method provide it's name as a key in third parameter and it's return value or callback function as parameter

<?php
$this->construct('User', [], ['save' => function () { return true; }]);
$this->construct('User', [], ['save' => true]);

• template RealInstanceType of object
• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked
• return MockObject&RealInstanceType
• throws Exception

public constructEmpty($class, array $constructorParams = Array ( ) , array $params = Array ( ) )

Instantiates a class instance by running constructor with all methods replaced with dummies. Parameters for constructor passed as second argument Properties and methods can be set in third argument. Even protected and private properties can be set.

<?php
$this->constructEmpty('User', ['autosave' => false]);
$this->constructEmpty('User', ['autosave' => false), ['name' => 'davert']);

Accepts either name of class or object of that class

<?php
$this->constructEmpty(new User, ['autosave' => false], ['name' => 'davert']);

To replace method provide it's name as a key in third parameter and it's return value or callback function as parameter

<?php
$this->constructEmpty('User', array(), array('save' => function () { return true; }));
$this->constructEmpty('User', array(), array('save' => true));

To create a mock, pass current testcase name as last argument:

<?php
$this->constructEmpty('User', [], [
     'save' => \Codeception\Stub\Expected::once()
]);

• template RealInstanceType of object
• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked
• return MockObject&RealInstanceType

public constructEmptyExcept($class, $method, array $constructorParams = Array ( ) , array $params = Array ( ) )

Instantiates a class instance by running constructor with all methods replaced with dummies, except one. Parameters for constructor passed as second argument Properties and methods can be set in third argument. Even protected and private properties can be set.

<?php
$this->constructEmptyExcept('User', 'save');
$this->constructEmptyExcept('User', 'save', ['autosave' => false], ['name' => 'davert']);

Accepts either name of class or object of that class

<?php
$this->constructEmptyExcept(new User, 'save', ['autosave' => false], ['name' => 'davert']);

To replace method provide it's name as a key in third parameter and it's return value or callback function as parameter

<?php
$this->constructEmptyExcept('User', 'save', [], ['save' => function () { return true; }]);
$this->constructEmptyExcept('User', 'save', [], ['save' => true]);

• template RealInstanceType of object
• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked
• return MockObject&RealInstanceType