cocur/human-date

Transforms dates into a human-readable form

Installs: 2 435

Dependents: 1

Stars: 19

Watchers: 2

Forks: 1

Open Issues: 3

Language: PHP

v0.1 2014-05-14 20:44 UTC

README

Transforms dates into a human-readable format.

Latest Stable Version Build Status Code Coverage

Features

  • Transforms dates into a human-readable format
  • Supports translatable strings
  • No external dependencies.
  • PSR-4 compatible.
  • Compatible with PHP >= 5.4 and HHVM.
  • Integrations for Symfony2 and Twig.

Installation

You can install cocur/human-date using Composer:

$ composer require cocur/human-date:@stable

In a production environment you should replace @stable with the version you want to use.

Usage

You can pass an instance of DateTime to the HumanDate::transform() method. For example, assuming that today is 2012-08-18:

use Cocur\HumanDate\HumanDate;

$humanDate = new HumanDate();

echo $humanDate->transform(new DateTime('now'));
// 'Today'

echo $humanDate->transform(new DateTime('+1 day'));
// 'Tomorrow'

echo $humanDate->transform(new DateTime('-1 day'));
// 'Yesterday'

echo $humanDate->transform(new DateTime('2012-08-21'));
// 'Next Tuesday'

echo $humanDate->transform(new DateTime('2012-09-30'));
// 'September 30'

echo $humanDate->transform(new DateTime('2013-03-30'));
// 'March 30, 2013'

Translation

HumanDate supports translation of strings. The Cocur\HumanDate\HumanDate constructor accepts an instance of Cocur\HumanDate\Translation\TranslationInterface.

$translation = MyTranslation(); // must implement `Cocur\HumanDate\Translation\TranslationInterface`
$humanDate = new HumanDate($translation);

echo $humanDate->transform(new DateTime('now'));
// Calls MyTranslation::trans()

Additionally the library includes an adapter for the Symfony Translation component.

Bridges

cocur/human-date contains bridges for Symfony and Twig.

Symfony

The Symfony bridge provides you with a bundle and an extension to use HumanDate as a service in your application.

# app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Cocur\HumanDate\Bridge\Symfony\CocurHumanDateBundle(),
        );
        // ...
    }

    // ...
}

You can now use the cocur_human_date service everywhere in your application, for example, in your controller:

$slug = $this->get('cocur_human_date')->slugify(new DateTime('2014-04-14'));

The bundle also provides an alias human_date for the cocur_human_date service:

$slug = $this->get('human_date')->slugify(new DateTime('2014-04-14'));
Translation

HumanDate includes an adapter for the Symfony Translation component. The adapter requires an instance of Symfony\Component\Translation\TranslatorInterface and additionally accepts a translation domain and locale. The adapters trans() method passes theses values to every call of Symfony\Component\Translation\TranslatorInterface::trans().

use Cocur\HumanDate\Bridge\Symfony\Translation\SymfonyTranslation;
use Cocur\HumanDate\HumanDate;

// Get or create an instance of Symfony\Component\Translation\TranslatorInterface
// For example, inside a controller
$sfTrans = $this->get('translation');

// Create an adapter with translation domain "human_date" and locale "en"
// trans() passes domain and locale to every call of Symfony\Component\Translation\TranslatorInterface::trans()
// If you omit the domain and locale it uses the defaults.
$trans = new SymfonyTranslation($sfTrans, 'human_date', 'en');

$humanDate = new HumanDate($trans);

Twig

If you use the Symfony2 framework with Twig you can use the Twig filter humanDate in your templates after you have setup Symfony2 integrations (see above).

{{ post.createdAt|humanDate }}

If you use Twig outside of the Symfony2 framework you first need to add the extension to your environment:

use Cocur\HumanDate\Bridge\Twig\HumanDateExtension;
use Cocur\HumanDate\HumanDate;

$twig = new Twig_Environment($loader);
$twig->addExtension(new HumanDateExtension(new HumanDate()));

You can find more information about registering extensions in the Twig documentation.

Changelog

Version 0.1 (14 May 2014)

  • Initial version (ported from BraincraftedHumanDateBundle)

Authors

License

The MIT License (MIT) Copyright (c) 2012 Florian Eckerstorfer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.