Mock.md

layout	doc
title	Mock - Codeception - Documentation

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, $params = null)

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.

{% highlight php %}

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

{% endhighlight %}

Accepts either name of class or object of that class

{% highlight php %}

make(new User, ['name' => 'davert']); ?>

{% endhighlight %}

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

{% highlight php %}

make('User', ['save' => function () { return true; }]); $this->make('User', ['save' => true]); {% endhighlight %} @template RealInstanceType of object * `param class-string|RealInstanceType|callable(): class-string` $class - A class to be mocked * `param array` $params - properties and methods to set @return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType - mock @throws \RuntimeException when class does not exist @throws \Exception #### *public* makeEmpty($class, $params = null) 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. {% highlight php %} makeEmpty('User'); $this->makeEmpty('User', ['name' => 'davert']); {% endhighlight %} Accepts either name of class or object of that class {% highlight php %} makeEmpty(new User, ['name' => 'davert']); {% endhighlight %} To replace method provide it's name as a key in second parameter and it's return value or callback function as parameter {% highlight php %} makeEmpty('User', ['save' => function () { return true; }]); $this->makeEmpty('User', ['save' => true)); {% endhighlight %} @template RealInstanceType of object * `param class-string|RealInstanceType|callable(): class-string` $class - A class to be mocked * `param array` $params * `param bool|\PHPUnit\Framework\TestCase` $testCase @return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType @throws \Exception #### *public* makeEmptyExcept($class, $method, $params = null) 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. {% highlight php %} makeEmptyExcept('User', 'save'); $this->makeEmptyExcept('User', 'save', ['name' => 'davert']); ?>

{% endhighlight %}

Accepts either name of class or object of that class

{% highlight php %}

makeEmptyExcept(new User, 'save'); ?>

{% endhighlight %}

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

{% highlight php %}

makeEmptyExcept('User', 'save', ['isValid' => function () { return true; }]); $this->makeEmptyExcept('User', 'save', ['isValid' => true]); {% endhighlight %} @template RealInstanceType of object * `param class-string|RealInstanceType|callable(): class-string` $class - A class to be mocked * `param string` $method * `param array` $params @return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType @throws \Exception #### *public* construct($class, $constructorParams = null, $params = null) 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. {% highlight php %} construct('User', ['autosave' => false]); $this->construct('User', ['autosave' => false], ['name' => 'davert']); ?>

{% endhighlight %}

Accepts either name of class or object of that class

{% highlight php %}

construct(new User, ['autosave' => false), ['name' => 'davert']); ?>

{% endhighlight %}

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

{% highlight php %}

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

{% endhighlight %}

@template RealInstanceType of object

• param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType> $class - A class to be mocked
• param array $constructorParams
• param array $params
• param bool|\PHPUnit\Framework\TestCase $testCase

@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType @throws \Exception

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

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.

{% highlight php %}

constructEmpty('User', ['autosave' => false]); $this->constructEmpty('User', ['autosave' => false), ['name' => 'davert']); {% endhighlight %} Accepts either name of class or object of that class {% highlight php %} constructEmpty(new User, ['autosave' => false], ['name' => 'davert']); {% endhighlight %} To replace method provide it's name as a key in third parameter and it's return value or callback function as parameter {% highlight php %} constructEmpty('User', array(), array('save' => function () { return true; })); $this->constructEmpty('User', array(), array('save' => true)); {% endhighlight %} **To create a mock, pass current testcase name as last argument:** {% highlight php %} constructEmpty('User', [], [ 'save' => \Codeception\Stub\Expected::once() ]); {% endhighlight %} @template RealInstanceType of object * `param class-string|RealInstanceType|callable(): class-string` $class - A class to be mocked * `param array` $constructorParams * `param array` $params @return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType #### *public* constructEmptyExcept($class, $method, $constructorParams = null, $params = null) 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. {% highlight php %} constructEmptyExcept('User', 'save'); $this->constructEmptyExcept('User', 'save', ['autosave' => false], ['name' => 'davert']); ?>

{% endhighlight %}

Accepts either name of class or object of that class

{% highlight php %}

constructEmptyExcept(new User, 'save', ['autosave' => false], ['name' => 'davert']); ?>

{% endhighlight %}

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

{% highlight php %}

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

{% endhighlight %}

@template RealInstanceType of object

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

@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType

public static never($params = null)

Checks if a method never has been invoked

If method invoked, it will immediately throw an exception.

{% highlight php %}

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

{% endhighlight %}

• param mixed $params @return StubMarshaler

public static once($params = null)

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.

{% highlight php %}

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

{% endhighlight %} Alternatively, a function can be passed as parameter:

{% highlight php %}

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

{% endhighlight %}

Alternatively, a function can be passed as parameter:

{% highlight php %}

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

{% endhighlight %} Alternatively, a function can be passed as parameter:

{% highlight php %}