php-randomdate/README.md
Josh Sherman 69c4a24301
feat: initial commit
Basic functionality and tests and all that.
2020-05-12 22:28:19 -05:00

42 lines
1 KiB
Markdown

# php-randomdate
Random time/date generator fully compatible with PHP's date function.
Compatible with PHP 5.3+.
## Installation
```shell
composer require joshtronic/php-randomdate
```
## Usage
```php
$rd = new joshtronic\RandomDate();
// Between the Unix Epoch and now
$rd->date(/* format string, default = 'c' */);
// Between January 1st, 1900 and now
$rd->min('1900-01-01')->date('Y-m-d');
// Between the Unix Epoch and next month
$rd->max('next month')->date('r');
// Between yesterday and tomorrow (at midnight)
$rd->between('yesterday', 'midnight tomorrow')->date('r');
// Reset minimum and maximum to defaults
$rd->reset->date();
```
## Compatibility with PHP functions
By design, this library aims to keep things simple by using the familiar
format string provided by PHP's existing [`date`][php-date] as well as the
extremely powerful [`strtotime`][php-strtotime] for setting the range of dates
used for generation.
[php-date]: https://www.php.net/manual/en/function.date.php
[php-strtotime]: https://www.php.net/manual/en/function.strtotime.php