Default column value with Doctrine2 and Symfony2 using YAML?

Question

Using annotations is quite simple to set a default value for a given column and initialize collections for entity relations:

use Doctrine\Common\Collections\ArrayCollection;

class Category
{   
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\OneToMany(targetEntity="Product", mappedBy="category")
     */
    protected $products;

    /**
     * @ORM\Column(type="bool")
     */
    protected $is_visible;

    public function __construct()
    {
        $this->products   = new ArrayCollection();
        $this->is_visible = true; // Default value for column is_visible
    }
}

How the same can be achieved using YAML definition instead, without manually write Category.php? Is __construct() the only method for doing this?

Acme\StoreBundle\Entity\Category:
    type: entity
    id:
        id:
            type: integer
            generator: { strategy: AUTO }
    fields:
        is_visible:
            type: bool
    oneToMany:
        products:
            targetEntity: Product
            mappedBy: category

Chris Haas · Accepted Answer · 2019-02-08 20:50:50Z

16

You can add default value for the column using options property in annotation or yaml. You can read more at doctrine annotation documentation.

Example for annotation:

/**
 * @ORM\Column(type="bool", name="is_visible", options={"default": false})
 */
protected $isVisible;

Example for YAML:

isVisible:
    type: boolean
    column: is_visible
    options: 
        default: false

edited Feb 8, 2019 at 20:50

Chris Haas

55.7k13 gold badges152 silver badges293 bronze badges

answered Oct 8, 2014 at 9:03

Artsiom Tymchanka

5276 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

youen Over a year ago

Thanks, this looks like the only valid answer if you are concerned about database migrations when adding a new column whose default value must be set for all existing objects. Setting the value in PHP would only work for new objects.

Matt · Accepted Answer · 2012-03-02 15:29:07Z

13

I think you misunderstood annotations somehow because the default value is set via plain php.

/**
 * @ORM\Column(type="bool") <- This is an annotation
 */
protected $is_visible;

public function __construct()
{
    $this->products   = new ArrayCollection(); // <- This is not an annotation
    $this->is_visible = true; // <- This is not an annotation
}

There is no difference using the YAML mapping for the default value. The reason is simple, here how you class is looking with annotations:

use Doctrine\Common\Collections\ArrayCollection;

class Category
{   
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\OneToMany(targetEntity="Product", mappedBy="category")
     */
    protected $products;

    /**
     * @ORM\Column(type="bool")
     */
    protected $is_visible;

    public function __construct()
    {
        $this->products   = new ArrayCollection();
        $this->is_visible = true; // Default value for column is_visible
    }
}

And this is how it looks with YAML mapping:

    use Doctrine\Common\Collections\ArrayCollection;

class Category
{   
    protected $id;
    protected $products;
    protected $is_visible;

    public function __construct()
    {
        $this->products   = new ArrayCollection();
        $this->is_visible = true; // Default value for column is_visible
    }
}

The difference in the second example is there is no more annotations, since the mapping is done via YAML. The construction of the class is done exactly the same. Thus, default values are set at construction time which is done in plain PHP.

There is no difference between annotations and YAML mapping for this task. So, bottom line, you need to edit the generated PHP class to put your default values. There is no way you can set it in YAML and let doctrine put this code for you, at least, at the time we speak.

Maybe I misunderstood your question :), if it is the case, don't hesitate to correct me.

Hope it helps.

Regards,
Matt

edited Mar 2, 2012 at 15:29

answered Mar 2, 2012 at 1:29

Matt

11k3 gold badges48 silver badges52 bronze badges

6 Comments

gremo Over a year ago

Nope annotation was clear to me (maybe my english it not so good to explai well). But you confirmed what i'm saying: using YAML you have to edit generated PHP class in order to set default values, right? There is not other way for doing this?

Sgoettschkes Over a year ago

There is no way to do this with annotations either. You have to manually add the construct method and add the default value.

Matt Over a year ago

Yep, as you said and @Boo confirmed, you need to put your default value in the generated PHP class directly. I have edited my answer to highlight this fact.

Cerad Over a year ago

Instead of using the constructor you should probably do something like protected $is_visible = true; Not positive if it really matters but I do know that doctrine hydrates it's objects without calling the constructor. Less code anyways.

Dimitry K Over a year ago

@Cerad is it really true but I do know that doctrine hydrates it's objects without calling the constructor? I was always wondering what exactly is algorithm Doctrine uses for hydrating entities. The problem I am working now: how to ensure integrity of the data when schema is updated (ie. field added) on the existing populated DB.. Because as this field did not exist before, what should be the default value of it... and how to behave around it.

|

caligari · Accepted Answer · 2013-02-15 02:14:10Z

2

You can try adding DEFAULT value with columnDefinition, but it is DDL and it depends on specific DBMS (bad thing). Following your example, the field *is_visible* using MySQL:

is_visible:
    type: bool
    columnDefinition: is_visible tinyint(1) NOT NULL DEFAULT '1'

In general, this is not a good idea and you are encouraged to use the constructor method or property initialization by code within the entity class...

answered Feb 15, 2013 at 2:14

caligari

2,12821 silver badges25 bronze badges

Comments

Amadey · Accepted Answer · 2016-02-08 14:57:09Z

1

The time has passed. Now you can set default value for a column through yaml.

columnName:
     type: string
     options:
          default: "someText"

answered Feb 8, 2016 at 14:57

Amadey

4811 gold badge4 silver badges9 bronze badges

Collectives™ on Stack Overflow

Default column value with Doctrine2 and Symfony2 using YAML?

4 Answers 4

1 Comment

6 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

6 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related