Search code examples
symfonydoctrinebundle

Good practices with entities when creating a bundle

I would like to create a bundle with some entities inside but how is the user of my bundle supposed to add a field to my entities if he wants to?

There is some case where the user may want to add fields to the entities of my bundle but he cannot modify the source files of my bundle in the vendor.

Should I abandon the idea to let a user add fields to my bundle's entities? Or what is the correct way to let him do that.

Solution

  • All you need to do is to suggest to the user in your documenation that they extend your base entity class.

    FOS userbundle suggests this, and can be seen here in this tutorial document

    It really should be as simple as that.

    You could also create a mapped superclass (probably abstract) so the user can extend those if needed. This approach is useful if you have multiple child entity classes from some kind of 'core' parent class which provides standard state or functionality.