Merge pull request #1119 from BraisGabin/patch-1

How to configure Doctrine using yaml

Author: stof

Resources/doc/groups.md

@@ -48,8 +48,9 @@ Or if you prefer XML:
 The simplest way to create a Group class is to extend the mapped superclass
 provided by the bundle.
 
-**a) ORM Group class implementation**
+#### a) ORM Group class implementation
 
+##### Annotations
 ``` php
 // src/MyProject/MyBundle/Entity/Group.php
 <?php
@@ -76,7 +77,47 @@ class Group extends BaseGroup
 
 **Note:** `Group` is a reserved keyword in SQL so it cannot be used as the table name.
 
-**b) MongoDB Group class implementation**
+##### yaml
+
+
+```php
+<?php
+// src/Acme/UserBundle/Entity/Group.php
+
+namespace Acme\UserBundle\Entity;
+
+use FOS\UserBundle\Entity\Group as BaseGroup;
+
+/**
+ * Group
+ */
+class Group extends BaseGroup
+{
+    /**
+     * @var integer
+     */
+    protected $id;
+
+    public function __construct()
+    {
+        parent::__construct();
+        // your own logic
+    }
+}
+```
+```yaml
+# src/Acme/UserBundle/Resources/config/doctrine/Group.orm.yml
+Acme\UserBundle\Entity\Group:
+    type:  entity
+    table: fos_group
+    id:
+        id:
+            type: integer
+            generator:
+                strategy: AUTO
+```
+
+#### b) MongoDB Group class implementation
 
 ``` php
 // src/MyProject/MyBundle/Document/Group.php
@@ -99,7 +140,7 @@ class Group extends BaseGroup
 }
 ```
 
-**c) CouchDB Group class implementation**
+#### c) CouchDB Group class implementation
 
 ``` php
 // src/MyProject/MyBundle/Document/Group.php
@@ -126,8 +167,9 @@ class Group extends BaseGroup
 
 The next step is to map the relation in your `User` class.
 
-**a) ORM User-Group mapping**
+#### a) ORM User-Group mapping
 
+##### Annotations
 ``` php
 // src/MyProject/MyBundle/Entity/User.php
 <?php
@@ -161,7 +203,62 @@ class User extends BaseUser
 }
 ```
 
-**b) MongoDB User-Group mapping**
+##### yaml
+```php
+<?php
+// src/Acme/UserBundle/Entity/User.php
+
+namespace Acme\UserBundle\Entity;
+
+use FOS\UserBundle\Entity\User as BaseUser;
+
+/**
+ * User
+ */
+class User extends BaseUser
+{
+    /**
+     * @var integer
+     */
+    protected $id;
+
+    /**
+     * @var \Doctrine\Common\Collections\Collection
+     */
+    protected $groups;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->groups = new \Doctrine\Common\Collections\ArrayCollection();
+        // your own logic
+    }
+}
+```
+```yaml
+# src/Acme/UserBundle/Resources/config/doctrine/User.orm.yml
+Acme\UserBundle\Entity\User:
+    type:  entity
+    table: fos_user
+    id:
+        id:
+            type: integer
+            generator:
+                strategy: AUTO
+    manyToMany:
+        groups:
+            targetEntity: Group
+            joinTable:
+                name: fos_user_group
+                joinColumns:
+                    user_id:
+                        referencedColumnName: id
+                inverseJoinColumns:
+                    group_id:
+                        referencedColumnName: id
+```
+
+#### b) MongoDB User-Group mapping
 
 ``` php
 // src/MyProject/MyBundle/Document/User.php
@@ -187,7 +284,7 @@ class User extends BaseUser
 }
 ```
 
-**c) CouchDB User-Group mapping**
+#### c) CouchDB User-Group mapping
 
 ``` php
 // src/MyProject/MyBundle/Document/User.php

Resources/doc/index.md

@@ -116,12 +116,14 @@ or CouchDB ODM).
 > to call parent::__construct(), as the base User class depends on
 > this to initialize some fields.
 
-**a) Doctrine ORM User class**
+#### a) Doctrine ORM User class
 
 If you're persisting your users via the Doctrine ORM, then your `User` class
 should live in the `Entity` namespace of your bundle and look like this to
 start:
 
+##### Annotations
+
 ``` php
 <?php
 // src/Acme/UserBundle/Entity/User.php
@@ -156,7 +158,48 @@ class User extends BaseUser
 
 > `User` is a reserved keyword in SQL so you cannot use it as table name.
 
-**b) MongoDB User class**
+##### yaml
+
+If you use yml to configure Doctrine you must add two files. The Entity and the orm.yml:
+
+```php
+<?php
+// src/Acme/UserBundle/Entity/User.php
+
+namespace Acme\UserBundle\Entity;
+
+use FOS\UserBundle\Entity\User as BaseUser;
+
+/**
+ * User
+ */
+class User extends BaseUser
+{
+    /**
+     * @var integer
+     */
+    protected $id;
+
+    public function __construct()
+    {
+        parent::__construct();
+        // your own logic
+    }
+}
+```
+```yaml
+# src/Acme/UserBundle/Resources/config/doctrine/User.orm.yml
+Acme\UserBundle\Entity\User:
+    type:  entity
+    table: fos_user
+    id:
+        id:
+            type: integer
+            generator:
+                strategy: AUTO
+```
+
+#### b) MongoDB User class
 
 If you're persisting your users via the Doctrine MongoDB ODM, then your `User`
 class should live in the `Document` namespace of your bundle and look like
@@ -189,7 +232,7 @@ class User extends BaseUser
 }
 ```
 
-**c) CouchDB User class**
+#### c) CouchDB User class
 
 If you're persisting your users via the Doctrine CouchDB ODM, then your `User`
 class should live in the `CouchDocument` namespace of your bundle and look like