FM / reference

/var/www/flurhymez/vendor/mockery/mockery/docs/reference/

/var/www/flurhymez/vendor/mockery/mockery/docs/reference

Name	Size	Mode	Actions
alternative_should_receive_syntax.rst	2381	0644	edit dl rm
argument_validation.rst	10745	0644	edit dl rm
creating_test_doubles.rst	14461	0644	edit dl rm
demeter_chains.rst	1639	0644	edit dl rm
expectations.rst	15126	0644	edit dl rm
final_methods_classes.rst	1351	0644	edit dl rm
index.rst	400	0644	edit dl rm
instance_mocking.rst	805	0644	edit dl rm
magic_methods.rst	687	0644	edit dl rm
map.rst.inc	550	0644	edit dl rm
partial_mocks.rst	4286	0644	edit dl rm
pass_by_reference_behaviours.rst	4322	0644	edit dl rm
phpunit_integration.rst	4853	0644	edit dl rm
protected_methods.rst	668	0644	edit dl rm
public_properties.rst	821	0644	edit dl rm
public_static_properties.rst	701	0644	edit dl rm
spies.rst	4737	0644	edit dl rm

Edit: /var/www/flurhymez/vendor/mockery/mockery/docs/reference/alternative_should_receive_syntax.rst (2381B)

.. index::
    single: Alternative shouldReceive Syntax

Alternative shouldReceive Syntax
================================

As of Mockery 1.0.0, we support calling methods as we would call any PHP method,
and not as string arguments to Mockery ``should*`` methods.

The two Mockery methods that enable this are ``allows()`` and ``expects()``.

Allows
------

We use ``allows()`` when we create stubs for methods that return a predefined
return value, but for these method stubs we don't care how many times, or if at
all, were they called.

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->allows([
        'name_of_method_1' => 'return value',
        'name_of_method_2' => 'return value',
    ]);

This is equivalent with the following ``shouldReceive`` syntax:

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->shouldReceive([
        'name_of_method_1' => 'return value',
        'name_of_method_2' => 'return value',
    ]);

Note that with this format, we also tell Mockery that we don't care about the
arguments to the stubbed methods.

If we do care about the arguments, we would do it like so:

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->allows()
        ->name_of_method_1($arg1)
        ->andReturn('return value');

This is equivalent with the following ``shouldReceive`` syntax:

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->shouldReceive('name_of_method_1')
        ->with($arg1)
        ->andReturn('return value');

Expects
-------

We use ``expects()`` when we want to verify that a particular method was called:

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->expects()
        ->name_of_method_1($arg1)
        ->andReturn('return value');

This is equivalent with the following ``shouldReceive`` syntax:

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->shouldReceive('name_of_method_1')
        ->once()
        ->with($arg1)
        ->andReturn('return value');

By default ``expects()`` sets up an expectation that the method should be called
once and once only. If we expect more than one call to the method, we can change
that expectation:

.. code-block:: php

$mock = \Mockery::mock('MyClass');
    $mock->expects()
        ->name_of_method_1($arg1)
        ->twice()
        ->andReturn('return value');

.. index:: single: Alternative shouldReceive Syntax Alternative shouldReceive Syntax ================================ As of Mockery 1.0.0, we support calling methods as we would call any PHP method, and not as string arguments to Mockery ``should*`` methods. The two Mockery methods that enable this are ``allows()`` and ``expects()``. Allows ------ We use ``allows()`` when we create stubs for methods that return a predefined return value, but for these method stubs we don't care how many times, or if at all, were they called. .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->allows([ 'name_of_method_1' => 'return value', 'name_of_method_2' => 'return value', ]); This is equivalent with the following ``shouldReceive`` syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive([ 'name_of_method_1' => 'return value', 'name_of_method_2' => 'return value', ]); Note that with this format, we also tell Mockery that we don't care about the arguments to the stubbed methods. If we do care about the arguments, we would do it like so: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->allows() ->name_of_method_1($arg1) ->andReturn('return value'); This is equivalent with the following ``shouldReceive`` syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method_1') ->with($arg1) ->andReturn('return value'); Expects ------- We use ``expects()`` when we want to verify that a particular method was called: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->expects() ->name_of_method_1($arg1) ->andReturn('return value'); This is equivalent with the following ``shouldReceive`` syntax: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->shouldReceive('name_of_method_1') ->once() ->with($arg1) ->andReturn('return value'); By default ``expects()`` sets up an expectation that the method should be called once and once only. If we expect more than one call to the method, we can change that expectation: .. code-block:: php $mock = \Mockery::mock('MyClass'); $mock->expects() ->name_of_method_1($arg1) ->twice() ->andReturn('return value');