Mocks

Declare mocks inside Codeception\Test\Unit class. If you want to use mocks outside it, check the reference for Codeception/Stub library.

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

• template RealInstanceType of object
• param $class
• param array $params - properties and methods to set
• throws RuntimeException when class does not exist
• throws Exception
• return MockObject&RealInstanceType - mock

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]);

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

• template RealInstanceType of object
• param $class
• param array $params
• throws Exception
• return MockObject&RealInstanceType

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]);

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

• template RealInstanceType of object
• param $class
• param string $method
• param array $params
• throws Exception
• return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType

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]);

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

• template RealInstanceType of object
• param $class
• param array $constructorParams
• param array $params
• throws Exception
• return MockObject&RealInstanceType

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]);

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

• template RealInstanceType of object
• param $class
• param array $constructorParams
• param array $params
• return MockObject&RealInstanceType

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()
]);

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

• template RealInstanceType of object
• param $class
• param string $method
• param array $constructorParams
• param array $params
• throws \ReflectionException
• return MockObject&RealInstanceType

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]);

public static never($params = null)

• param mixed $params
• return \Codeception\Stub\StubMarshaler

Checks if a method never has been invoked

If method invoked, it will immediately throw an exception.

<?php
use \Codeception\Stub\Expected;

$user = $this->make('User', [
     'getName' => Expected::never(),
     'someMethod' => function() {}
]);
$user->someMethod();

public static once($params = null)

• param mixed $params
• return \Codeception\Stub\StubMarshaler

Checks if a method has been invoked exactly one time.

If the number is less or greater it will later be checked in verify() and also throw an exception.

<?php
use \Codeception\Stub\Expected;

$user = $this->make(
    'User',
    array(
        'getName' => Expected::once('Davert'),
        'someMethod' => function() {}
    )
);
$userName = $user->getName();
$this->assertEquals('Davert', $userName);

Alternatively, a function can be passed as parameter:

<?php
Expected::once(function() { return Faker::name(); });

public static atLeastOnce($params = null)

• param mixed $params
• return \Codeception\Stub\StubMarshaler

Checks if a method has been invoked at least one time.

If the number of invocations is 0 it will throw an exception in verify.

<?php
use \Codeception\Stub\Expected;

$user = $this->make(
    'User',
    array(
        'getName' => Expected::atLeastOnce('Davert')),
        'someMethod' => function() {}
    )
);
$user->getName();
$userName = $user->getName();
$this->assertEquals('Davert', $userName);

Alternatively, a function can be passed as parameter:

<?php
Expected::atLeastOnce(function() { return Faker::name(); });

public static exactly($count, $params = null)

• param int $count
• param mixed $params
• return \Codeception\Stub\StubMarshaler

Checks if a method has been invoked a certain amount of times.

If the number of invocations exceeds the value it will immediately throw an exception, If the number is less it will later be checked in verify() and also throw an exception.

<?php
use \Codeception\Stub;
use \Codeception\Stub\Expected;

$user = $this->make(
    'User',
    array(
        'getName' => Expected::exactly(3, 'Davert'),
        'someMethod' => function() {}
    )
);
$user->getName();
$user->getName();
$userName = $user->getName();
$this->assertEquals('Davert', $userName);

Alternatively, a function can be passed as parameter:

<?php
Expected::exactly(function() { return Faker::name() });