Download the PHP package consistence/consistence-doctrine without Composer
On this page you can find all versions of the php package consistence/consistence-doctrine. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download consistence/consistence-doctrine
More information about consistence/consistence-doctrine
Files in consistence/consistence-doctrine
Package consistence-doctrine
Short Description Integration of Consistence library with Doctrine ORM
License MIT
Informations about the package consistence-doctrine
Integration of Consistence library with Doctrine ORM
This library provides integration of Consistence value objects for Doctrine ORM so that you can use them in your entities.
For now, the only integration which is needed is for Enums, see the examples below.
Usage
Enums represent predefined set of values and of course, you will want to store these values in your database as well. Since Enums
are objects and you only want to store the represented value, there has to be some mapping.
You can see it in this example where you want to store sex for your User
s:
To use the Sex
enum in your User
entity notice the type="enum<Consistence\Doctrine\Example\User\Sex>"
in ORM\Column
- this will be used for mapping the value to and from your database. You can specify any other parameters for ORM\Column
as you would usually (nullability, length...).
Before this will work with database, we need to register Doctrine DBAL type for each enum.
If you are using Symfony, you can use
consistence/consistence-doctrine-symfony
, where you can just configure which types should be registered.If you do this in code, note that this step contains static calls which have global effect. I recommend putting them inside a bootstrap file (usually where you register the Composer autoloader now), which is run or included when the application starts.
We used StringEnumType
because the Sex
enum uses strings for its values. There are also IntegerEnumType
, FloatEnumType
and BooleanEnumType
- depending on what scalar values are used in the enum.
If you use the same enum in multiple places register it only once.
Now everything is ready to be used, when you call flush
, only female
will be saved:
And when you retrieve the entity back from database, you will receive the Sex
enum object again:
This means that the objects API is symmetrical (you get the same type as you set) and you can start benefiting from Enums advantages such as being sure, that what you get is already a valid value and having the possibility to define methods on top of the represented values.
Installation
If you are using Symfony, you can use
consistence/consistence-doctrine-symfony
, which will take care of the integration.
1) Install package consistence/consistence-doctrine
with Composer:
2) Register needed DBAL types (see Usage
section above).
That's all, you are good to go!
All versions of consistence-doctrine with dependencies
consistence/consistence Version ^1.0|^2.0
doctrine/dbal Version ^2.13.1|^3.0