indieweb/date-formatter

Render dates and date ranges in a human-readable format, including proper microformats-2 markup

Tuesday, April 5, 2016
by aaronpk
Repository
11 Watchers
17 Stars
5,144 Installations

PHP
0 Dependents
0 Suggesters
1 Forks
2 Open issues
10 Versions
9 % Grown

The README.md

Date Formatter

Render dates and date ranges in a human-readable format, including proper microformats-2 markup., _(*1)

, _(*2)

Usage

Date Range with Time

echo IndieWeb\DateFormatter::format('2013-10-08T07:00:00-07:00', '2013-10-08T17:00:00-07:00');

outputs, _(*3)

<time class="dt-start" datetime="2013-10-08T07:00:00-07:00">
  October 8, 2013 from 7:00am
</time>
to
<time class="dt-end" datetime="2013-10-08T17:00:00-07:00">
  5:00pm (-0700)
</time>

(whitespace added for readability), _(*4)

which displays in a browser as, _(*5)

October 8, 2013 from 7:00am to 5:00pm (-0700)

Date Range with No Time

echo IndieWeb\DateFormatter::format('2013-10-08', '2013-10-11');

outputs, _(*6)

<time class="dt-start" datetime="2013-10-08">
  October 8
</time>
-
<time class="dt-end" datetime="2013-10-11">
  11, 2013
</time>

which displays in a browser as, _(*7)

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., _(*8)

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., _(*9)

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., _(*10)

echo IndieWeb\DateFormatter::format('2013-10-08T07:00:00-0700', '2013-10-08T08:50:00-0700', 'dt-departure', 'dt-arrival');

<time class="dt-departure" datetime="2013-10-08T07:00:00-07:00">
  October 8, 2013 from 7:00am
</time>
to
<time class="dt-arrival" datetime="2013-10-08T8:50:00-07:00">
  8:50am (-0700)
</time>

Tests

Please see the tests for more complete examples of different output formats., _(*11)

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:, _(*12)

  public function testDescriptionOfWhatYoureTesting() {
    $this->_testEquals('Final Text Output', 'start-date', 'end-date');
  }

License

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, _(*14)

http://www.apache.org/licenses/LICENSE-2.0, _(*15)

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., _(*16)

The Versions

05/04 2016

dev-master

9999999-dev https://github.com/indieweb/date-formatter-php

Render dates and date ranges in a human-readable format, including proper microformats-2 markup

Sources Download

Apache-2.0

The Requires

php >=5.3.0

The Development Requires

by Aaron Parecki

date format microformats microformats2

05/04 2016

0.3.1

0.3.1.0 https://github.com/indieweb/date-formatter-php

Render dates and date ranges in a human-readable format, including proper microformats-2 markup

Sources Download

Apache-2.0

The Requires

php >=5.3.0

The Development Requires

by Aaron Parecki

date format microformats microformats2

15/03 2016

0.3.0

0.3.0.0 https://github.com/indieweb/date-formatter-php

Render dates and date ranges in a human-readable format, including proper microformats-2 markup

Sources Download

Apache-2.0

The Requires

php >=5.3.0

The Development Requires

by Aaron Parecki

date format microformats microformats2

01/01 2016

0.2.0

0.2.0.0 https://github.com/indieweb/date-formatter-php

Render dates and date ranges in a human-readable format, including proper microformats-2 markup

Sources Download

Apache-2.0

The Requires

php >=5.3.0

php >=5.3.0

by Aaron Parecki

date format microformats microformats 2

library date-formatter

Render dates and date ranges in a human-readable format, including proper microformats-2 markup

indieweb/date-formatter

The README.md

Date Formatter

Usage

Date Range with Time

Date Range with No Time

Other Examples

Alternate Class Names

Tests

Future Enhancements

License

The Versions

dev-master

The Requires

The Development Requires

by Aaron Parecki

0.3.1

The Requires

The Development Requires

by Aaron Parecki

0.3.0

The Requires

The Development Requires

by Aaron Parecki

0.2.0

The Requires

The Development Requires

by Aaron Parecki

0.1.6

The Requires

by Aaron Parecki

0.1.5

The Requires

by Aaron Parecki

0.1.4

The Requires

by Aaron Parecki

0.1.3

The Requires

by Aaron Parecki

0.1.2

The Requires

by Aaron Parecki

0.1.1

The Requires

by Aaron Parecki