Download the PHP package slope-it/clock-mock without Composer
On this page you can find all versions of the php package slope-it/clock-mock. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package clock-mock
ClockMock
ClockMock provides a way for mocking the current timestamp used by PHP for \DateTime(Immutable) objects and date/time related functions. It requires the uopz extension (version >= 6.1.1).
This library is meant for development and testing only. It does not aim to propose a clock service to be used in production code, as we believe that you shouldn't need to do that when your only purpose is to mock the current time in testing code.
Why we built it
Here is an article that explains in depth how and why this library was built: link to the article.
TL;DR
- We were looking for a way to mock the native php date and time functions and classes without having to change our production code for it, and without having ot use any 3rd party library for handling dates/clocks.
- For this purpose, we were previously using the
php-timecopextension but that never implemented support for PHP 7.4 onward.
Installation
You can install the library using Composer. Run the following command to install the latest version from Packagist:
Note that, as this is not a tool intended for production, it should be required only for development (--dev flag).
Mocked functions/methods
- date()
- date_create()
- date_create_from_format()
- date_create_immutable()
- date_create_immutable_from_format()
- getdate()
- gettimeofday()
- gmdate()
- gmmktime()
- gmstrftime() (DEPRECATED starting from PHP 8.1)
- idate()
- localtime()
- microtime()
- mktime()
- strftime() (DEPRECATED starting from PHP 8.1)
- strtotime()
- time()
- unixtojd()
- DateTime::__construct
- DateTime::createFromFormat
- DateTimeImmutable::__construct
- DateTimeImmutable::createFromFormat
- $_SERVER['REQUEST_TIME']
- $_SERVER['REQUEST_TIME_FLOAT']
Usage
1. Stateful API
You can call ClockMock::freeze with a \DateTime or \DateTimeImmutable. Any code executed after it will use that
specific date and time as the current timestamp.
Call ClockMock::reset when done to restore real, current time.
Example:
2. Stateless API
The library also provides a closure-based API that will execute the provided code at a specific point in time. This API does not need manually freezing or re-setting time, so it can be less error prone in some circumstances.
Example:
How to contribute
- Did you find and fix any bugs in the existing code?
- Do you want to contribute a new feature, or a missing mock?
- Do you think documentation can be improved?
Under any of these circumstances, please fork this repo and create a pull request. We are more than happy to accept contributions!
Credits
- php-timecop, as ClockMock was inspired by it.
- ext-uopz, as ClockMock is just a very thin layer on top of the amazing uopz extension, which provides a very convenient way to mock any function or method, including the ones of the php stdlib, at runtime.
All versions of clock-mock with dependencies
ext-uopz Version >=6.1.1