Skip to content

Add details on how the ClockMock::register works #8899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions components/phpunit_bridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,54 @@ test::

And that's all!

.. caution::

The ``@group time-sensitive`` annotation is equivalent to ``ClockMock::register(MyTest::class)``,
so if you want to get a time-based function mocked into another class you will need to
add it explicitly using ``ClockMock::register(MyClass::class)``. The ``ClockMock::register`` method
creates a mock of the time based functions into the same namespace as your class. So when using
``time()`` you will use the mock instead of the default one::

namespace App;

class MyClass
{
public function getTimeInHours()
{
return time() / 3600;
}
}

.. code-block:: php

namespace App\Tests;

use App\MyClass;
use PHPUnit\Framework\TestCase;

/**
* @group time-sensitive
*/
class MyTest extends TestCase
{
public function testGetTimeInHours()
{
ClockMock::register(MyClass::class);

$my = new MyClass();

$result = $my->getTimeInHours();

$this->assertEquals(time() / 3600, $result);
}
}

.. caution::

Keep in mind that mocking is done by using the namespace resolutions rules
(http://php.net/manual/en/language.namespaces.rules.php). So time-based functions need to be used as
"Unqualified name", i.e. ``\time()`` cannot be mocked.

.. tip::

An added bonus of using the ``ClockMock`` class is that time passes
Expand Down