https://github.com/indieweb/date-formatter-php
Render dates and date ranges in a human-readable format, including proper microformats-2 markup
https://github.com/indieweb/date-formatter-php
Last synced: 6 months ago
JSON representation
Render dates and date ranges in a human-readable format, including proper microformats-2 markup
- Host: GitHub
- URL: https://github.com/indieweb/date-formatter-php
- Owner: indieweb
- Created: 2013-07-06T23:17:12.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2016-04-05T15:15:44.000Z (about 9 years ago)
- Last Synced: 2024-10-29T18:59:59.052Z (7 months ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 18
- Watchers: 13
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Date Formatter
==============
Render dates and date ranges in a human-readable format, including proper microformats-2 markup.
[](http://travis-ci.org/indieweb/date-formatter-php)
Usage
-----
### Date Range with Time
```php
echo IndieWeb\DateFormatter::format('2013-10-08T07:00:00-07:00', '2013-10-08T17:00:00-07:00');
```
outputs
```html
to
```
(whitespace added for readability)
which displays in a browser as
```
October 8, 2013 from 7:00am to 5:00pm (-0700)
```
### Date Range with No Time
```php
echo IndieWeb\DateFormatter::format('2013-10-08', '2013-10-11');
```
outputs
```html
-
```
which displays in a browser as
```
October 8-11, 2013
```
Other Examples
--------------
This example shows how progressively more data is added to the output as the start and end dates have less in common with each other.
```php
use IndieWeb\DateFormatter;
echo DateFormatter::format('2013-09-03', '2013-09-08');
// September 3-8, 2013
echo DateFormatter::format('2013-09-28', '2013-10-03');
// September 28 through October 3, 2013
echo DateFormatter::format('2013-12-30', '2014-01-02');
// December 30, 2013 through January 2, 2014
```
Here are similar examples when the dates include times as well.
```php
use IndieWeb\DateFormatter;
echo DateFormatter::format('2013-10-08T07:00:00-07:00', '2013-10-08T17:00:00-07:00');
// October 8, 2013 from 7:00am to 5:00pm (-0700)
echo DateFormatter::format('2013-10-08T07:00:00-07:00', '2013-10-10T17:00:00-07:00');
// October 8, 2013 at 7:00am until Oct 10 at 5:00pm (-0700)
echo DateFormatter::format('2013-08-31T07:00:00-07:00', '2013-09-01T17:00:00-07:00');
// August 31, 2013 7:00am until September 1 at 5:00pm (-0700)
echo DateFormatter::format('2013-12-31T07:00:00-07:00', '2014-01-01T17:00:00-07:00');
// December 31, 2013 7:00am until January 1, 2014 5:00pm (-0700)
```
Alternate Class Names
---------------------
If you want the HTML to include Microformats classes other than "dt-start" and "dt-end", you can pass class names as additional parameters.
```php
echo IndieWeb\DateFormatter::format('2013-10-08T07:00:00-0700', '2013-10-08T08:50:00-0700', 'dt-departure', 'dt-arrival');
```
```html
to
```
Tests
-----
Please see the [tests](tests/BasicTest.php) for more complete examples of different output formats.
Future Enhancements
-------------------
* Optionally also display the day of the week in date range output
* Option to use short month names instead of full names
* Make the parser more tolerant of other input formats
If you see other input or output formats you would like handled, please open an Issue with a description. Bonus points if you write it as a test case:
```php
public function testDescriptionOfWhatYoureTesting() {
$this->_testEquals('Final Text Output', 'start-date', 'end-date');
}
```
License
-------
Copyright 2015 by Aaron Parecki
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.