Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ambroisemaupate/date2sentence
A simple lexer to print human readable dates.
https://github.com/ambroisemaupate/date2sentence
Last synced: 3 months ago
JSON representation
A simple lexer to print human readable dates.
- Host: GitHub
- URL: https://github.com/ambroisemaupate/date2sentence
- Owner: ambroisemaupate
- Created: 2017-07-05T15:38:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T22:30:36.000Z (over 1 year ago)
- Last Synced: 2024-09-14T05:48:30.633Z (4 months ago)
- Language: PHP
- Size: 75.2 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Date2Sentence
A simple lexer to print human readable dates.
[](https://app.travis-ci.com/ambroisemaupate/date2Sentence)
### Requires
- PHP 7.4 min.
- PHP-intl extension
### Available lexers
- English
- French
- German
### Usage
```bash
composer require ambroisemaupate/date-to-sentence
```
```php
use AM\Date2Sentence\EnglishDateLexer;
$lexer = new EnglishDateLexer();
$lexer->setDates([
new DateTime('2017-06-01'),
new DateTime('2017-06-02'),
new DateTime('2017-06-03'),
]);
echo $lexer->toSentence();
// "From June 1st to June 3rd"
$lexer->setDates([
new DateTime('2017-06-01'),
new DateTime('2017-06-02'),
new DateTime('2017-06-03'),
new DateTime('2017-06-10'),
]);
echo $lexer->toSentence();
// "From June 1st to June 3rd and June 10th"
```
#### With wrap option
```php
use AM\Date2Sentence\EnglishDateLexer;
$nonContinuousLexer = new EnglishDateLexer([
new DateTime('2017-06-01'),
new DateTime('2017-06-02'),
new DateTime('2017-06-03'),
new DateTime('2017-06-10'),
], ['wrap_format' => '%s']);
echo $nonContinuousLexer->toSentence();
// "From June 1st to June 3rd and June 10th"
```
#### With French lexer
```php
use AM\Date2Sentence\FrenchDateLexer;
$lexer = new FrenchDateLexer([
new DateTime('2017-06-01'),
new DateTime('2017-06-02'),
new DateTime('2017-06-03'),
]);
echo $lexer->toSentence();
// "Du 1er au 3 juin"
$nonContinuousLexer = new FrenchDateLexer([
new DateTime('2017-06-01'),
new DateTime('2017-06-02'),
new DateTime('2017-06-03'),
new DateTime('2017-06-10'),
]);
echo $nonContinuousLexer->toSentence();
// "Du 1er au 3 juin et le 10 juin"
```
#### Setting tolerance
Set tolerance **before** dates to changes how days are listed. You can force
*from-to* writing even if there are some missing days (e.g. weekends).
```php
use AM\Date2Sentence\EnglishDateLexer;
$nonContinuousLexer = new EnglishDateLexer();
// Tolerate 1 missing day between dates.
$nonContinuousLexer->setTolerance(1);
$nonContinuousLexer->setDates([
new DateTime('2017-06-01'),
// no 2nd
new DateTime('2017-06-03'),
// no 4th
new DateTime('2017-06-05'),
// no 6th
new DateTime('2017-06-07'),
]);
echo $nonContinuousLexer->toSentence();
// "From June 1st to June 7th"
```
#### Grouping by month
*Date2Sentence* is made to group days within the same month not
to repeat same month-name over and over.
```php
use AM\Date2Sentence\EnglishDateLexer;
$nonContinuousLexer = new EnglishDateLexer();
$nonContinuousLexer->setDates([
new DateTime('2017-06-01'),
// no 2nd
new DateTime('2017-06-03'),
// no 4th
new DateTime('2017-06-05'),
// no 6th
new DateTime('2017-06-07'),
new DateTime('2017-07-01'),
]);
echo $nonContinuousLexer->toSentence();
// "June 1st, 3rd, 5th, 7th and July 1st"
//
// In French, it works too…
// "Les 1er, 2, 5, 7 juin et le 1er juillet"
```
#### Get hours
*Date2Sentence* can also extract times from your given dates:
```php
use AM\Date2Sentence\EnglishDateLexer;
$lexer = new EnglishDateLexer();
$lexer->setDates([
new DateTime('2017-06-01 20:00:00'),
new DateTime('2017-06-03 21:00:00'),
new DateTime('2017-06-05 20:00:00'),
new DateTime('2017-06-07 21:00:00'),
new DateTime('2017-07-01 20:00:00'),
]);
echo json_encode(array_keys($this->getLexer()->getAvailableTimes()));
// [
// "20:00",
// "21:00"
// ]
```
#### Get dates as array
If you need to render manually you date groups, you can use generic `toArray` method
which will group start and end dates into arrays. Dates in same array are continuous, separate
arrays mean that they’re not continuous.
```php
use AM\Date2Sentence\EnglishDateLexer;
$lexer = new EnglishDateLexer();
$lexer->setDates([
new DateTime('2017-06-01 20:00:00'),
new DateTime('2017-06-02 21:00:00'),
new DateTime('2017-06-03 21:00:00'),
new DateTime('2017-07-01 20:00:00'),
new DateTime('2017-07-02 21:00:00'),
new DateTime('2017-07-03 21:00:00'),
]);
echo json_encode($this->getLexer()->toArray());
// [
// [
// {"date":"2017-06-01 20:00:00.000000","timezone_type":3,"timezone":"Europe\/Paris"},
// {"date":"2017-06-03 21:00:00.000000","timezone_type":3,"timezone":"Europe\/Paris"}
// ],
// [
// {"date":"2017-07-01 20:00:00.000000","timezone_type":3,"timezone":"Europe\/Paris"},
// {"date":"2017-07-03 21:00:00.000000","timezone_type":3,"timezone":"Europe\/Paris"}
// ]
// ]
```
#### Get days of week
*Date2Sentence* can also extract days of week from your given dates, day will be
represented as their number (1 for Monday, 7 for Sunday) and will be ordered:
```php
use AM\Date2Sentence\EnglishDateLexer;
$lexer = new EnglishDateLexer();
$lexer->setDates([
new DateTime('2017-06-01'),
new DateTime('2017-06-02'),
new DateTime('2017-06-03'),
new DateTime('2017-06-08'),
new DateTime('2017-06-08'),
]);
echo json_encode($this->getLexer()->getAvailableDaysOfWeek());
// [
// 4,
// 5,
// 6
// ]
```
## Tests
```bash
vendor/phpunit/phpunit/phpunit --bootstrap vendor/autoload.php test
```