An open API service indexing awesome lists of open source software.

https://github.com/potherca-blog/php-timecop-example

http://blog.pother.ca/php-timecop-example/ Examples demonstrating how PHP TimeCop works
https://github.com/potherca-blog/php-timecop-example

blog-article example example-app example-code example-codes example-project example-projects example-repo examples examples-php php php-example php-examples php-extensions php-module php-modules php-timecop potherca potherca-blog timecop

Last synced: 10 days ago
JSON representation

http://blog.pother.ca/php-timecop-example/ Examples demonstrating how PHP TimeCop works

Awesome Lists containing this project

README

          

![PHP TimeCop Logo](logo-timecop.png)

> _"There is never enough time."_
> ~ Max Walker

[![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b/remix-button.svg)](https://glitch.com/edit/#!/remix/php-timecop)

## Introduction

The [php-timecop](https://github.com/hnw/php-timecop) PHP extension
makes it possible to manipulate time as experienced by the PHP runtime.

It provides "time travel" and "time freezing" capabilities.

This can be very useful when testing code that has time-sensitive functionality.

This project offers examples demonstrating how PHP TimeCop works.

It can be seen in action at https://php-timecop.glitch.me/

To play around with it, [remix this project on Glitch](https://glitch.com/edit/#!/remix/php-timecop).

## Usage

1. [Install php-timecop](https://github.com/hnw/php-timecop#install-with-package-manager) on a PHP server of your choice.
2. Clone this repository to the same server.
3. Visit the `index.php` in a web browser.
4. Study the provided examples and their output.
5. ...
6. [Profit!](http://knowyourmeme.com/memes/profit)

## Features

PHP TimeCop offers four functions to manipulate time.

For the static class method a regular function is also available (execept for `return` as that is a reserved word in PHP):

- `TimeCop::freeze($new_time)` / `timecop_freeze($new_time)`
- `timecop_return()`
- `TimeCop::scale($scaling_factor)` / `timecop_scale($scaling_factor)`
- `TimeCop::travel($new_time)` / `timecop_travel($new_time)`

### Freeze

Used to statically mock the concept of "now".

As the PHP runtime executes, `time()` will not change unless subsequent calls to freeze/return/scale/travel are made.

### Return

Return the system to a normal state. Effectively "turn off" php-timecop

### Scale

Make time move at an accelerated pace. With this function, long time spans can be emulated in a shorter time.

### Travel

Computes an offset between the currently think `time()` and the time passed in. It uses this offset to simulate the passage of time.

## Examples

The result of these examples can be seen below.

### Freeze

```php
format('Y-m-d H:i:s'));
Timecop::scale(86400); // time passes at one day per second
sleep(1);
var_dump((new DateTime())->format('Y-m-d H:i:s'));
sleep(1);
var_dump((new DateTime())->format('Y-m-d H:i:s'));
```

### Travel

```php