-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -231,6 +231,51 @@ test:: | |
} | ||
|
||
And that's all! | ||
|
||
.. caution:: | ||
|
||
The ``@group time-sensitive`` annotation is equivalent to ``ClockMock::register(MyTest::class)``, | ||
so if you want to mock a time based function mocked into one of the source code you will need to | ||
add it explicitly using ``ClockMock::register(MyClass::class)``. The ``ClockMock::register`` method | ||
only create 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. | ||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Extra empty line can be removed. |
||
.. code-block:: | ||
|
||
namespace App; | ||
|
||
class MyClass | ||
{ | ||
public function getTimeInHours() | ||
{ | ||
return time() / 3600; | ||
} | ||
} | ||
|
||
.. code-block:: | ||
|
||
namespace Tests/App; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
use PHPUnit\Framework\TestCase; | ||
use App\MyClass; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please use an alpha order? |
||
|
||
/** | ||
* @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); | ||
} | ||
} | ||
|
||
.. tip:: | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if you want to mock a time based function into ...
orif you want to get a time based function mocked into ...
?