mof/timestampable

Generates automatically creation and update's date of Doctrine entity property

v2.1.0 2019-07-14 14:11 UTC

Requires

• php: ^7.0
• doctrine/annotations: ^1.4
• doctrine/orm: ^2.5

Requires (Dev)

• codeception/base: ^2.5.6

MIT

• Ryan Farrah

README

Presentation

This little library for Doctrine projects allows you to automatically handle creation and update on certain properties of your entity.

How install

You need to install it via composer :

composer require mof/timestampable

Then you need to register the annotations and add the event subscriber to the Doctrine event manager :

AnnotationRegistry::registerLoader('class_exists'); //This register the annotation

$annotationReader = new AnnotationReader();
$eventManager->addEventSubscriber(new TimestampableSubscriber($annotationReader));

You can give to the TimestampableSubcriber constructor any class that implements the Doctrine\Common\Annotations\Reader interface.

Then you ready to go.

Usage

In your entity, you can add the events the property will listen to, there are 2 events available :

/**
 * When an entity is created
 * @var \DateTime
 * @ORM\Column(type="datetime", name="created_at")
 * @Timestampable(on=Timestampable::ON_CREATE)
 */
protected $createdAt;

/**
 * When an entity is updated (the date is also set when an entity is created)
 * @var \DateTime
 * @ORM\Column(type="datetime", name="updated_at")
 * @Timestampable(on=Timestampable::ON_UPDATE)
 */
protected $updatedAt;

Tests

You can run the tests by cloning the project and then type :

composer install
vendor/bin/codecept run

The tests use sqlite for the database behind the scene, for more information, see https://www.php.net/manual/fr/sqlite.installation.php.