Adding createdAt and updatedAt Timestampable Fields
Keep on Learning!
If you liked what you've learned so far, dive in! Subscribe to get access to this tutorial plus video, code and script downloads.
Adding createdAt and updatedAt Timestampable Fields¶
Let’s do more magic! I always like to have createdAt and updatedAt fields on my database tables. A lot of times, this helps me debug any weird behavior I may see in the future.
The DoctrineExtensions library does this for us. It’s called timestampable, enable it in config.yml:
# app/config/config.yml
# ...
stof_doctrine_extensions:
orm:
default:
sluggable: true
timestampable: true
Head to the timestampable section of the documentation to see how this works. We already have the Gedmo annotation, so just copy in the created and updated properties and rename them to createdAt and updatedAt, just because I like those names better:
// src/Yoda/EventBundle/Entity/Event.php
// ...
/**
* @Gedmo\Timestampable(on="create")
* @ORM\Column(type="datetime")
*/
private $createdAt;
/**
* @Gedmo\Timestampable(on="update")
* @ORM\Column(type="datetime")
*/
private $updatedAt;
And now we’ll generate getter methods for these:
/**
* @return \DateTime
*/
public function getCreatedAt()
{
return $this->createdAt;
}
/**
* @return \DateTime
*/
public function getUpdatedAt()
{
return $this->updatedAt;
}
We can also add setter methods if we want, but we don’t need them: the library will set these for us!
Next, update the database schema to add the two new fields and then reload the fixtures:
php app/console doctrine:schema:update --force
php app/console doctrine:fixtures:load
Query for the events again:
php app/console doctrine:query:sql "SELECT * FROM yoda_event"
Nice! Both the createdAt and updatedAt columns are properly set. To avoid sadness and regret add these fields to almost every table.
10 Comments
I will use this
@ORM\Column(name="updated_at", type="datetime", options={"default"="1970-01-01 00:00:00"})same error version latest symfonyHey Himanshu,
That error means that when you create a User entity - you do not set the createdAt properly. You should either do this manually somewhere where you do
new User(). Or you can leverage the Timestampable feature from the bundle we're talking about in this video. If it does not work for you automatically, then it means the bundle isn't installed or configured properly.Cheers!
there is a typo in header:
updatdAt
Thanks! Fixed at https://github.com/knpunive...
If you try to add
createdAtandupdatedAtfields to an existing database table which already has data (thus you don't want to purge and recreate schema), you will run into those errors:and this:
To avoid this problem you can communicate to MySQL default value of those columns by declaring fields like this:
Hey Dimitry,
You're right, thank you for sharing this! There's also another solution: use "nullable=true" for those fields.
Cheers!
Hey Victor,
settings `nullable=true` is a good option as well (and shorter thus lazier). However I chose _not_ to use it and use "default" approach, because then I don't have to add to my codebase any special cases for when `createdAt` or `updatedAt` is null.
Hey Dimitry,
Agree! And there's another approach: if you use migrations, you can do some extra queries there and do not use `options={"default"="1970-01-01 00:00:00"} ` or `nullable=true` at all ;)
Cheers!
The bundle introduced here is not available for Symfony 3.x, is it?
Hey Pascal Q (pascal.)
Yes, it still works, you can use it safely. You can find more information here: https://symfony.com/doc/cur...
Cheers!
"Houston: no signs of life"
Start the conversation!