Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/garyjones/daterange
PHP: Display a range of dates, with consolidated time parts.
https://github.com/garyjones/daterange
date date-range php71
Last synced: about 1 month ago
JSON representation
PHP: Display a range of dates, with consolidated time parts.
- Host: GitHub
- URL: https://github.com/garyjones/daterange
- Owner: GaryJones
- License: mit
- Created: 2018-05-16T19:27:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-03T18:40:16.000Z (over 6 years ago)
- Last Synced: 2024-11-16T15:47:37.118Z (about 2 months ago)
- Topics: date, date-range, php71
- Language: PHP
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Gamajo Date Range
[](https://packagist.org/packages/gamajo/daterange)
[](https://packagist.org/packages/gamajo/daterange)
[](https://packagist.org/packages/gamajo/daterange)
[](https://packagist.org/packages/gamajo/daterange)
Display a range of dates, with consolidated time parts.
## Table Of Contents
* [Installation](#installation)
* [Basic Usage](#basic-usage)
* [Advanced Usage](#advanced-usage)
* [Contributing](#contributing)
* [License](#license)
## Installation
The best way to use this package is through Composer:
```BASH
composer require gamajo/daterange
```
## Basic Usage
Create an instance of the `DateRange` class, with `DateTimeImmutable` or `DateTime` start and end date-time objects as arguments. Then choose the format to use as the end date output. The start date will only display the time parts that are not duplicated.
```php
$dateRange = new DateRange(
new DateTimeImmutable('23rd June 18 14:00'),
new DateTimeImmutable('2018-06-23T15:00')
);
echo $dateRange->format('H:i d M Y'); // 14:00 – 15:00 23 Jun 2018
```
If the formatted date would be the same start and end date, only a single date is displayed:
```php
$dateRange = new DateRange(
new DateTimeImmutable('23rd June 18 14:00'),
new DateTimeImmutable('2018-06-23T15:00')
);
echo $dateRange->format('jS M Y'); // 23rd Jun 2018
```
## Advanced Usage
### Change Separator
The default separator between the start and end date, is a space, en-dash, space: `' – '`
This can be changed via the `changeSeparator()` method:
```php
$dateRange = new DateRange(
new DateTimeImmutable('23rd June 18 14:00'),
new DateTimeImmutable('2018-06-23T15:00')
);
$dateRange->changeSeparator(' to ');
echo 'From ', $dateRange->format('H:i d M Y'); // From 14:00 to 15:00 23 Jun 2018
```
### Change Removable Delimiters
The consolidation and removal of some time parts may leave delimiters from the format:
```php
$dateRange = new DateRange(
new DateTimeImmutable('23rd June 18'),
new DateTimeImmutable('2018-06-24')
);
echo $dateRange->format('d·M·Y'); // 23·· – 24·Jun·2018
```
Be default, `/`, `-` and `.` are trimmed from the start date, but this can be amended with the `changeRemovableDelimiters()` method:
```php
$dateRange = new DateRange(
new DateTimeImmutable('23rd June 18'),
new DateTimeImmutable('2018-06-24')
);
$dateRange->changeRemovableDelimiters('·');
echo $dateRange->format('d·M·Y'); // 23 – 24·Jun·2018
```
## Known Issues
These are known issues which need addressing before this package can be considered stable:
- [Escaped characters are not handled correctly](https://github.com/GaryJones/daterange/issues/2)
- [Duplicate time parts are not handled correctly](https://github.com/GaryJones/daterange/issues/3)
- [Hours, minutes and seconds are not handled correctly](https://github.com/GaryJones/daterange/issues/4)
## Contributing
All feedback, bug reports and pull requests are welcome.
## License
Copyright (c) 2018 Gary Jones, Gamajo
This code is licensed under the [MIT License](LICENSE).