Merge pull request #2189 from michaelcullum/task/code-block-consistency

Fix code block consistency

Author: XWB

Resources/doc/adding_invitation_registration.rst

@@ -11,6 +11,9 @@ Invitation model
 First we need to add the invitation entity. An invitation is represented
 by a unique code/identifier generated in the constructor::
 
+    <?php
+    // src/AppBundle/Entity/Invitation.php
+
     namespace AppBundle\Entity;
 
     use Doctrine\ORM\Mapping as ORM;
@@ -67,6 +70,9 @@ by a unique code/identifier generated in the constructor::
 
 Next we map our ``Invitation`` entity to our ``User`` with a one-to-one association::
 
+    <?php
+    // src/AppBundel/Entity/User.php
+
     namespace AppBundle\Entity;
 
     use Doctrine\ORM\Mapping as ORM;
@@ -101,6 +107,9 @@ Add invitation to RegistrationFormType
 
 Override the default registration form with your own::
 
+    <?php
+    // src/AppBundle/Form/RegistrationFormType.php
+
     namespace AppBundle\Form;
 
     use Symfony\Component\Form\AbstractType;
@@ -126,6 +135,9 @@ Override the default registration form with your own::
 
 Create the invitation field::
 
+    <?php
+    // src/AppBundle/Form/InvitationFormType.php
+
     namespace AppBundle\Form;
 
     use Symfony\Component\Form\AbstractType;
@@ -169,6 +181,9 @@ Create the invitation field::
 
 Create the custom data transformer::
 
+    <?php
+    // src/AppBundle/Form/InvitationToCodeTransformer.php
+
     namespace AppBundle\Form\DataTransformer;
 
     use AppBundle\Entity\Invitation;

Resources/doc/emails.rst

@@ -114,7 +114,8 @@ implementation instead. It expects your twig template to define 3 blocks:
 - ``body_text`` rendering the plain text version of the message
 - ``body_html`` rendering the html mail
 
-Here is how you can use it:
+Here is how you can use it, you can use either of the two methods
+of referencing the email template below.
 
 .. code-block:: yaml
 
@@ -125,7 +126,10 @@ Here is how you can use it:
             mailer: fos_user.mailer.twig_swift
         resetting:
             email:
-                template: email/password_resetting.email.twig
+                template:   email/password_resetting.email.twig
+        registration:
+            confirmation:
+                template:   FOSUserBundle:Registration:email.txt.twig
 
 .. code-block:: html+jinja
 
@@ -158,6 +162,10 @@ Here is how you can use it:
     The HTML part is set in the message only when the ``body_html`` block is
     not empty.
 
+You can view the default email templates at
+`FOSUserBundle:Registration:email.txt.twig` and
+`FOSUserBundle:Resetting:email.txt.twig`
+
 Using A Custom Mailer
 ---------------------
 

Resources/doc/groups.rst

@@ -60,9 +60,10 @@ a) ORM Group class implementation
 
     .. code-block:: php-annotations
 
-        // src/MyProject/MyBundle/Entity/Group.php
+        <?php
+        // src/AppBundle/Entity/Group.php
 
-        namespace MyProject\MyBundle\Entity;
+        namespace AppBundle\Entity;
 
         use FOS\UserBundle\Entity\Group as BaseGroup;
         use Doctrine\ORM\Mapping as ORM;
@@ -102,9 +103,10 @@ b) MongoDB Group class implementation
 
 .. code-block:: php
 
-    // src/MyProject/MyBundle/Document/Group.php
+    <?php
+    // src/AppBundle/Document/Group.php
 
-    namespace MyProject\MyBundle\Document;
+    namespace AppBundle\Document;
 
     use FOS\UserBundle\Document\Group as BaseGroup;
     use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
@@ -125,9 +127,10 @@ c) CouchDB Group class implementation
 
 .. code-block:: php
 
-    // src/MyProject/MyBundle/CouchDocument/Group.php
+    <?php
+    // src/AppBundle/CouchDocument/Group.php
 
-    namespace MyProject\MyBundle\CouchDocument;
+    namespace AppBundle\CouchDocument;
 
     use FOS\UserBundle\Document\Group as BaseGroup;
     use Doctrine\ODM\CouchDB\Mapping\Annotations as CouchDB;
@@ -155,9 +158,10 @@ a) ORM User-Group mapping
 
     .. code-block:: php-annotations
 
-        // src/MyProject/MyBundle/Entity/User.php
+        <?php
+        // src/AppBundle/Entity/User.php
 
-        namespace MyProject\MyBundle\Entity;
+        namespace AppBundle\Entity;
 
         use FOS\UserBundle\Entity\User as BaseUser;
         use Doctrine\ORM\Mapping as ORM;
@@ -176,7 +180,7 @@ a) ORM User-Group mapping
             protected $id;
 
             /**
-             * @ORM\ManyToMany(targetEntity="MyProject\MyBundle\Entity\Group")
+             * @ORM\ManyToMany(targetEntity="AppBundle\Entity\Group")
              * @ORM\JoinTable(name="fos_user_user_group",
              *      joinColumns={@ORM\JoinColumn(name="user_id", referencedColumnName="id")},
              *      inverseJoinColumns={@ORM\JoinColumn(name="group_id", referencedColumnName="id")}
@@ -237,9 +241,10 @@ b) MongoDB User-Group mapping
 
 .. code-block:: php
 
-    // src/MyProject/MyBundle/Document/User.php
+    <?php
+    // src/AppBundle/Document/User.php
 
-    namespace MyProject\MyBundle\Document;
+    namespace AppBundle\Document;
 
     use FOS\UserBundle\Document\User as BaseUser;
     use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
@@ -253,7 +258,7 @@ b) MongoDB User-Group mapping
         protected $id;
 
         /**
-         * @MongoDB\ReferenceMany(targetDocument="MyProject\MyBundle\Document\Group")
+         * @MongoDB\ReferenceMany(targetDocument="AppBundle\Document\Group")
          */
         protected $groups;
     }
@@ -263,9 +268,10 @@ c) CouchDB User-Group mapping
 
 .. code-block:: php
 
-    // src/MyProject/MyBundle/CouchDocument/User.php
+    <?php
+    // src/AppBundle/CouchDocument/User.php
 
-    namespace MyProject\MyBundle\CouchDocument;
+    namespace AppBundle\CouchDocument;
 
     use FOS\UserBundle\Document\User as BaseUser;
     use Doctrine\ODM\CouchDB\Mapping\Annotations as CouchDB;
@@ -281,7 +287,7 @@ c) CouchDB User-Group mapping
         protected $id;
 
         /**
-         * @CouchDB\ReferenceMany(targetDocument="MyProject\MyBundle\CouchDocument\Group")
+         * @CouchDB\ReferenceMany(targetDocument="AppBundle\CouchDocument\Group")
          */
         protected $groups;
     }

Resources/doc/overriding_controllers.rst

@@ -12,6 +12,7 @@ bundle named ``AcmeUserBundle`` that declares itself a child of FOSUserBundle.
 
 .. code-block:: php
 
+    <?php
     // src/Acme/UserBundle/AcmeUserBundle.php
 
     namespace Acme\UserBundle;
@@ -42,6 +43,7 @@ the base controller and adds logging a new user registration to it.
 
 .. code-block:: php
 
+    <?php
     // src/Acme/UserBundle/Controller/RegistrationController.php
 
     namespace Acme\UserBundle\Controller;

Resources/doc/overriding_forms.rst

@@ -68,6 +68,7 @@ the form type hierarchy and then adds the custom ``name`` field.
 
 .. code-block:: php
 
+    <?php
     // src/AppBundle/Form/RegistrationType.php
 
     namespace AppBundle\Form;
@@ -173,6 +174,7 @@ protected ``onSuccess`` method.
 
 .. code-block:: php
 
+    <?php
     // src/AppBundle/Form/Handler/RegistrationFormHandler.php
 
     namespace AppBundle\Form\Handler;
@@ -206,6 +208,7 @@ successful submission.
 
 .. code-block:: php
 
+    <?php
     // src/AppBundle/Form/Handler/RegistrationFormHandler.php
 
     namespace AppBundle\Form\Handler;

Resources/doc/overriding_templates.rst

@@ -107,6 +107,7 @@ class.
 
 .. code-block:: php
 
+    <?php
     // src/Acme/UserBundle/AcmeUserBundle.php
 
     namespace Acme\UserBundle;