\ShmockPHPUnitSpec

__construct()

__construct(\PHPUnit_Framework_TestCase $test, \Shmock\Instance $shmock, string $method, array $with, bool $order_matters, int $call_index)

This class is not directly instantiated, but instead returned every time you invoke a method on a \Shmock\Instance or \Shmock\StaticClass.

Specs in Shmock make the assumption that because you are mocking the method that it will be invoked at least once. This is a default setting on the mock and can be changed by specifying a number of times to invoke the method, as done above with the twice() method. Callers intending to invoke methods more than once with different arguments are directed to the return_value_map facility or to specify $mock->order_matters();.

A few options on specs can be in conflict with each other. For example, you may elect to return a value to the caller via return_value($v), throw an exception via throw_exception($e) or to perform a custom action via will(function () {}). In cases of a conflict, last expectation set wins.

PHPUnit specs also accept standar \PHPUnit_Framework_Constraint instances as arguments, so wildcard arguments or other helpers from PHPUnit are available for use:

 $calc->add($this->greaterThan(1), $this->lessThan(2));

Parameters

times()

times(int $times) : \Shmock\PHPUnitSpec

Specify that the method will be invoked $times times.

 // expect notify will be called 5 times
 $shmock->notify()->times(5);

Parameters

Returns

once()

once() : \Shmock\PHPUnitSpec

Specify that the method will be invoked once.

This is a shorthand for times(1)

Returns

twice()

twice() : \Shmock\PHPUnitSpec

Specify that the method will be invoked twice.

This is a shorthand for times(2)

Returns

any()

any() : \Shmock\PHPUnitSpec

Specifies that the number of invocations of this method is not to be verified by Shmock.

 $shmock->notify()->any();

This is a shorthand for times(null)

Returns

never()

never() : \Shmock\PHPUnitSpec

Specifies that this method is never to be invoked.

This is an alias for times(0)

Returns

at_least_once()

at_least_once() : \Shmock\PHPUnitSpec

Specifies that the method is to be invoked at least once but possibly more.

This directive is only respected if no other calls to times() have been recorded.

 $shmock->notify()->at_least_once();

Returns

will()

will(callable $will_closure) : \Shmock\PHPUnitSpec

Specifies that the given closure will be executed on invocation.

The first argument to the closure is an instance of \PHPUnit_Framework_MockObject_Invocation.

 // custom action with a closure

 $shmock->notify()->will(function ($invocation) {
   $this->assertTrue(count($invocation->parameters) > 2);
 });

Parameters

Returns

return_value_map()

return_value_map(mixed[][] $map_of_args_to_values) : \Shmock\PHPUnitSpec

An order-agnostic set of return values given a set of inputs.

Parameters

Returns

For example, if you were simulating addition:

$shmock_calculator->add()->return_value_map([
    [1, 2, 3], // 1 + 2 = 3
    [10, 15, 25],
    [11, 11, 22]
]);

return_true()

return_true() : \Shmock\PHPUnitSpec

Specifies that the method will return true.

This is a shorthand for return_value(true)

Returns

return_false()

return_false() : \Shmock\PHPUnitSpec

Specifies that the method will return false.

This is a shorthand for return_value(false)

Returns

return_null()

return_null() : \Shmock\PHPUnitSpec

Specifies that the method will return null.

This is a shorthand for return_value(null)

Returns

return_value()

return_value(mixed|null $value) : \Shmock\PHPUnitSpec

Specifies that the method will return the given value on invocation.

 $shmock->notify()->return_value("notification!");

Parameters

Returns

return_this()

return_this() : \Shmock\PHPUnitSpec

Specifies that the method will return the invocation target. This is useful for mocking other objects that have fluent interfaces.

 $latte->add_foam()->return_this();
 $latte->caffeine_free()->return_this();

Returns

throw_exception()

throw_exception(\Exception|void $e) : \Shmock\PHPUnitSpec

Throws an exception on invocation.

Parameters

Returns

return_consecutively()

return_consecutively(mixed[] $array_of_values, boolean|void $keep_returning_last_value) : \Shmock\PHPUnitSpec

Specifies that each subsequent invocation of this method will take the subsequent value from the array as the return value.

The sequence of values to return is not affected by ordering constraints on the mock (ie, order_matters()).

 $shmock->notify()->return_consecutively(["called!", "called again!", "called a third time!"]);

 $mock = $shmock->replay(); // replay is automatically called at the end of \Shmock\Shmock::create()

 $mock->notify(); // called!
 $mock->notify(); // called again!
 $mock->notify(); // called a third time!

Parameters

Returns

return_shmock()

return_shmock(string $class, callable $shmock_closure) : \Shmock\PHPUnitSpec

Specifies that the return value from this function will be a new mock object, which is built and replayed as soon as the invocation has occurred.

The signature of return_shmock() is similar to \Shmock\Shmock::create() except that the test case argument is omitted

 $user = \Shmock\Shmock::create($this, 'User', function ($user) {
   $user->supervisor()->return_shmock('Supervisor', function ($supervisor) {
     $supervisor->send_angry_email("I need you to work this weekend");
   });
 });

Parameters

Returns