Merge branch '3.4' into 4.2

javiereguiluz · javiereguiluz · commit 04a043b8d16b · 2019-04-04T09:04:48.000+02:00
* 3.4:
  Use a configuration-block directive
  move the namespace before the use statements
  be consistent ´with the following code example
  wrap code example with class
  added use statement and filepath to be consistent
  remove blank line after filepath in php code examples
  fix use statement
  try to make the code examples less noisy
diff --git a/components/console/changing_default_command.rst b/components/console/changing_default_command.rst
@@ -31,7 +31,6 @@ name to the ``setDefaultCommand()`` method::
 Executing the application and changing the default command::
 
     // application.php
-
     use Acme\Console\Command\HelloWorldCommand;
     use Symfony\Component\Console\Application;
 
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -245,23 +245,32 @@ The definition of serialization can be specified using annotations, XML
 or YAML. The :class:`Symfony\\Component\\Serializer\\Mapping\\Factory\\ClassMetadataFactory`
 that will be used by the normalizer must be aware of the format to use.
 
-Initialize the :class:`Symfony\\Component\\Serializer\\Mapping\\Factory\\ClassMetadataFactory`
-like the following::
+The following code shows how to initialize the :class:`Symfony\\Component\\Serializer\\Mapping\\Factory\\ClassMetadataFactory`
+for each format:
 
-    use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
-    // For annotations
-    use Doctrine\Common\Annotations\AnnotationReader;
-    use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
-    // For XML
-    // use Symfony\Component\Serializer\Mapping\Loader\XmlFileLoader;
-    // For YAML
-    // use Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader;
+.. configuration-block::
 
-    $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
-    // For XML
-    // $classMetadataFactory = new ClassMetadataFactory(new XmlFileLoader('/path/to/your/definition.xml'));
-    // For YAML
-    // $classMetadataFactory = new ClassMetadataFactory(new YamlFileLoader('/path/to/your/definition.yaml'));
+    .. code-block:: php-annotations
+
+        use Doctrine\Common\Annotations\AnnotationReader;
+        use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+        use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
+
+        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+
+    .. code-block:: yaml
+
+        use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+        use Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader;
+
+        $classMetadataFactory = new ClassMetadataFactory(new YamlFileLoader('/path/to/your/definition.yaml'));
+
+    .. code-block:: xml
+
+        use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+        use Symfony\Component\Serializer\Mapping\Loader\XmlFileLoader;
+
+        $classMetadataFactory = new ClassMetadataFactory(new XmlFileLoader('/path/to/your/definition.xml'));
 
 .. _component-serializer-attributes-groups-annotations:
 
@@ -966,10 +975,10 @@ Here, we set it to 2 for the ``$child`` property:
 
     .. code-block:: php-annotations
 
-        use Symfony\Component\Serializer\Annotation\MaxDepth;
-
         namespace Acme;
 
+        use Symfony\Component\Serializer\Annotation\MaxDepth;
+
         class MyObj
         {
             /**
@@ -1233,13 +1242,13 @@ When using the component standalone, an implementation of :class:`Symfony\\Compo
 (usually an instance of :class:`Symfony\\Component\\PropertyInfo\\PropertyInfoExtractor`) must be passed as the 4th
 parameter of the ``ObjectNormalizer``::
 
+    namespace Acme;
+
     use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
     use Symfony\Component\Serializer\Serializer;
     use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
     use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 
-    namespace Acme;
-
     class ObjectOuter
     {
         private $inner;
diff --git a/components/yaml.rst b/components/yaml.rst
@@ -394,7 +394,6 @@ First, install the Console component:
 Create a console application with ``lint:yaml`` as its only command::
 
     // lint.php
-
     use Symfony\Component\Console\Application;
     use Symfony\Component\Yaml\Command\LintCommand;
 
diff --git a/configuration/micro_kernel_trait.rst b/configuration/micro_kernel_trait.rst
@@ -282,7 +282,6 @@ Finally, you need a front controller to boot and run the application. Create a
 ``public/index.php``::
 
     // public/index.php
-
     use App\Kernel;
     use Doctrine\Common\Annotations\AnnotationRegistry;
     use Symfony\Component\HttpFoundation\Request;
diff --git a/doctrine/lifecycle_callbacks.rst b/doctrine/lifecycle_callbacks.rst
@@ -15,6 +15,9 @@ callbacks. This is not necessary if you're using YAML or XML for your mapping.
 
 .. code-block:: php-annotations
 
+    // src/Entity/Product.php
+    use Doctrine\ORM\Mapping as ORM;
+
     /**
      * @ORM\Entity()
      * @ORM\HasLifecycleCallbacks()
@@ -33,6 +36,7 @@ the current date, only when the entity is first persisted (i.e. inserted):
     .. code-block:: php-annotations
 
         // src/Entity/Product.php
+        use Doctrine\ORM\Mapping as ORM;
 
         /**
          * @ORM\PrePersist
diff --git a/doctrine/pdo_session_storage.rst b/doctrine/pdo_session_storage.rst
@@ -150,7 +150,6 @@ a second array argument to ``PdoSessionHandler``:
     .. code-block:: php
 
         // config/services.php
-
         use Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler;
         // ...
 
diff --git a/doctrine/resolve_target_entity.rst b/doctrine/resolve_target_entity.rst
@@ -40,7 +40,6 @@ brevity) to explain how to set up and use the ``ResolveTargetEntityListener``.
 A Customer entity::
 
     // src/Entity/Customer.php
-
     namespace App\Entity;
 
     use Doctrine\ORM\Mapping as ORM;
@@ -60,10 +59,9 @@ A Customer entity::
 An Invoice entity::
 
     // src/Acme/InvoiceBundle/Entity/Invoice.php
-
     namespace Acme\InvoiceBundle\Entity;
 
-    use Doctrine\ORM\Mapping AS ORM;
+    use Doctrine\ORM\Mapping as ORM;
     use Acme\InvoiceBundle\Model\InvoiceSubjectInterface;
 
     /**
@@ -84,7 +82,6 @@ An Invoice entity::
 An InvoiceSubjectInterface::
 
     // src/Acme/InvoiceBundle/Model/InvoiceSubjectInterface.php
-
     namespace Acme\InvoiceBundle\Model;
 
     /**
diff --git a/form/dynamic_form_modification.rst b/form/dynamic_form_modification.rst
@@ -236,11 +236,16 @@ service into the form type so you can get the current user object::
     use Symfony\Component\Security\Core\Security;
     // ...
 
-    private $security;
-
-    public function __construct(Security $security)
+    class FriendMessageFormType extends AbstractType
     {
-        $this->security = $security;
+        private $security;
+
+        public function __construct(Security $security)
+        {
+            $this->security = $security;
+        }
+
+        // ....
     }
 
 Customizing the Form Type
@@ -250,7 +255,6 @@ Now that you have all the basics in place you can use the features of the
 security helper to fill in the listener logic::
 
     // src/Form/Type/FriendMessageFormType.php
-
     use App\Entity\User;
     use Doctrine\ORM\EntityRepository;
     use Symfony\Bridge\Doctrine\Form\Type\EntityType;
diff --git a/form/form_collections.rst b/form/form_collections.rst
@@ -515,6 +515,7 @@ you will learn about next!).
 
         // src/Entity/Task.php
 
+        // ...
         public function addTag(Tag $tag)
         {
             // for a many-to-many association:
@@ -648,7 +649,6 @@ the relationship between the removed ``Tag`` and ``Task`` object.
     is handling the "update" of your Task::
 
         // src/Controller/TaskController.php
-
         use App\Entity\Task;
         use Doctrine\Common\Collections\ArrayCollection;
 
diff --git a/form/form_dependencies.rst b/form/form_dependencies.rst
@@ -77,7 +77,6 @@ Suppose you need to access the :ref:`EntityManager <doctrine-entity-manager>` ob
 so that you can make a query. First, add this as an argument to your form class::
 
     // src/Form/TaskType.php
-
     use Doctrine\ORM\EntityManagerInterface;
     // ...
 
diff --git a/service_container/factories.rst b/service_container/factories.rst
@@ -132,6 +132,7 @@ Configuration of the service container then looks like this:
         // config/services.php
         use App\Email\NewsletterManager;
         use App\Email\NewsletterManagerFactory;
+        use Symfony\Component\DependencyInjection\Reference;
         // ...
 
         $container->register(NewsletterManagerFactory::class);
diff --git a/workflow/usage.rst b/workflow/usage.rst
@@ -117,7 +117,6 @@ like this:
     .. code-block:: php
 
         // config/packages/workflow.php
-
         $container->loadFromExtension('framework', [
             // ...
             'workflows' => [
