#DateInterval Bundle

##Description

Provides additonnal features to handle DateIntervals (A period of time, ex: 2 months and 4 days).

This bundle provides:

• A DBAL Type to save \DateInterval to database. (Based on herrera-io/php-doctrine-dateinterval, but let you handle the DBAL Type registration)
• A FormType, providing a way to get user input.

The "herrera-io/date-interval" dependency also add the following features:

• convert DateInterval to the interval spec
• convert DateInterval to the number of seconds
  • convert back to DateInterval from the number of seconds

The conversion to seconds requires a bit of explaining.

##Installation

Add the following dependency to your composer.json file:

{
    "require": {
        "_other_packages": "...",
        "ogizanagi/dateintervalbundle": "dev-master"
    }
}

##Use the new DBAL type

config.yml:

doctrine:
    dbal:
        types:
            dateinterval: Ogi\DateIntervalBundle\DBAL\Types\DateIntervalType

        connections:
            default:
                driver:   %database_driver%
                ...

                #Custom type declarations for SchemaTool
                mapping_types:
                    dateinterval: bigint

<?php

/**
 * @Entity()
 * @Table(name="Reminders")
 */
class Reminder
{
    /**
     * @Column(type="integer")
     * @GeneratedValue(strategy="AUTO")
     * @Id()
     */
    private $id;

    /**
     * @Column(type="dateinterval")
     */
    private $interval;

    /**
     * @return DateInterval
     */
    public function getInterval()
    {
        return $this->interval;
    }

    /**
     * @param DateInterval $interval
     */
    public function setInterval(DateInterval $interval = null)
    {
        $this->interval = $interval;
    }
}

//Remind me every day
$reminder = new Reminder();
$reminder->setInterval(new DateInterval('P1D'));

$em->persist($annualJob);
$em->flush();

echo $reminder->getInterval()->toSpec(); // "P1D"

NOTICE The date interval instances returned are of Herrera\DateInterval\DateInterval, inherited from \DateInterval

##Use the DateInterval FormType

public function buildForm(FormBuilderInterface $builder, array $options)
    {
        ...

        $builder
            ->add('interval', 'ogi_dateinterval', array(
                'label' => 'Remind me every...',
                'required' => false,
                'with_hours' => false,
                'with_minutes' => false,
                'with_seconds' => false,
            ))
        ;
    }

This bundle isn't quite complete. The following improvements could be made:

• The FormType sould allow to:
  • Select a choice range for every picker (years, months, days, hours, seconds).
  • For every picker, add an option to display it or not (years, months, days, hours, seconds).
• A default & overridable view should be provided for the form type. (including, why not, a bootstrap 2 and 3 one)
• The Doctrine DQL function from herrera-io/php-doctrine-dateinterval should be included, but as the DBAL type, must remains loadable or not by the developer, through config.
• Maybe the custom DBAL type should be prefixed by the ogi_ namespace, to avoid conflicts.
• Any other suggested improvements.