kamilkrzywda/doctrine-dateinterval

Supports DateInterval in Doctrine DBAL and ORM.

dev-master / 1.0.x-dev 2016-02-04 09:33 UTC

Requires

• php: >=5.3.3
• doctrine/dbal: >=2.2.3,<2.4-dev
• kamilkrzywda/date-interval: >=1.0-dev,<2.0-dev

Requires (Dev)

• doctrine/orm: >=2.2.3,<2.4-dev
• phpunit/phpunit: 3.7.*

MIT

• Kevin Herrera

• date
• doctrine
• interval

README

Supports DateInterval in Doctrine DBAL and ORM.

Summary

The DateInterval library

• adds a dateinterval type to DBAL
• adds a DATE_INTERVAL DQL function to ORM

This is made possible by the DateInterval library.

Installation

Add it to your list of Composer dependencies:

$ composer require herrera-io/doctrine-dateinterval=1.*

Register it with Doctrine DBAL:

<?php

use Doctrine\DBAL\Types\Type;
use Herrera\Doctrine\DBAL\Types\DateIntervalType;

Type::addType(
    DateIntervalType::DATEINTERVAL,
    'Herrera\\Doctrine\\DBAL\\Types\\DateIntervalType'
);

Register it with Doctrine ORM:

<?php

$entityManager->getConfiguration()->addCustomDatetimeFunction(
    'Herrera\\Doctrine\\ORM\\Query\\AST\\Functions\\DateIntervalFunction'
);

Usage

<?php

/**
 * @Entity()
 * @Table(name="Jobs")
 */
class Job
{
    /**
     * @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)
    {
        $this->interval = $interval;
    }
}

$annualJob = new Job();
$annualJob->setInterval(new DateInterval('P1Y'));

$monthlyJob = new Job();
$monthlyJob->setInterval(new DateInterval('P1M'));

$dailyJob = new Job();
$dailyJob->setInterval(new DateInterval('P1D'));

$entityManager->persist($annualJob);
$entityManager->persist($monthlyJob);
$entityManager->persist($dailyJob);
$entityManager->flush();
$entityManager->clear();

$jobs = $entityManager->createQuery(
    "SELECT j FROM Jobs j WHERE j.interval < DATE_INTERVAL('P1Y') ORDER BY j.interval ASC"
)->getResult();

echo $jobs[0]->getInterval()->toSpec(); // "P1D"
echo $jobs[1]->getInterval()->toSpec(); // "P1M"

NOTICE The date interval instances returned are of Herrera\DateInterval\DateInterval.