Merge branch '3.4' into 4.0

* 3.4: (23 commits)
  Fix YAML identation
  Update rendering.rst
  Update formatter.rst
  remove part about adding extension
  Add "allowed_classes" argument for unserialize()
  Removed another unneeded closing block name
  Fix little typo
  Fix "class_exists" PHP function URL
  add missing ";"
  Remove faulty PHP code blocks
  Fix typo in method setETag. Correct method name is setEtag
  Changes after code review
  Changes after code review
  Changes after code review
  Minor changes to the previous merge
  Rewrite the gender-neutral pronoun section to reflect an inclusive viewpoint for everyone
  Replace jQuery example with plain JavaScript
  Update controller.rst
  Add cautionary advice about SQL reserved words
  Fix "JsonSerializable" URL
  ...

Author: xabbuh

components/cache/psr6_psr16_adapters.rst

@@ -37,7 +37,7 @@ instead. No problem! The Cache component provides the
 this use-case::
 
     use Symfony\Component\Cache\Simple\FilesystemCache;
-    use Symfony\Component\Cache\Adapter\SimpleCacheAdapter
+    use Symfony\Component\Cache\Adapter\SimpleCacheAdapter;
 
     // the PSR-16 cache object that you want to use
     $psr16Cache = new FilesystemCache();

contributing/community/review-comments.rst

@@ -43,16 +43,18 @@ that, but swearing/cursing and name calling doesn't really encourage anyone to
 help you. Take a deep breath, count to 10 and try to *clearly* explain what problems
 you encounter.
 
-Gender-neutral Pronouns
------------------------
+Inclusive Language
+------------------
 
-While not "formally" required, it's better to use gender-neutral pronouns.
-Unless someone "indicated" their pronouns, use "they", "them" instead of
-"he", "she", "his", "hers", "his/hers", "he/she", etc.
+In an effort to be inclusive to a wide group of people, it's recommended to
+use personal pronouns that don't suggest a particular gender. Unless someone
+has stated their pronouns, use "they", "them" instead of "he", "she", "his",
+"hers", "his/hers", "he/she", etc.
 
-Try to avoid using wording that may be considered excluding and needlessly gendered,
-like for example words that have a male base. For example we recommend to use other
-words like "folks", "team", "everyone" in place of "guys".
+Try to avoid using wording that may be considered excluding, needlessly gendered
+(e.g. words that have a male or female base), racially motivated or singles out
+a particular group in society. For example, it's recommended to use words like
+"folks", "team", "everyone" instead of "guys", "ladies", "yanks", etc.
 
 Giving Positive Feedback
 ------------------------

controller.rst

@@ -182,7 +182,7 @@ method renders a template **and** puts that content into a ``Response``
 object for you::
 
     // renders templates/lucky/number.html.twig
-    return $this->render('lucky/number.html.twig', array('name' => $name));
+    return $this->render('lucky/number.html.twig', array('number' => $number));
 
 Templating and Twig are explained more in the
 :doc:`Creating and Using Templates article </templating>`.

form/rendering.rst

@@ -21,7 +21,7 @@ of code. Of course, you'll usually need much more flexibility when rendering:
 
     .. code-block:: html+php
 
-        <!-- templates/default/newAction.html.php -->
+        <!-- templates/default/new.html.php -->
         <?php echo $view['form']->start($form) ?>
             <?php echo $view['form']->errors($form) ?>
 

frontend/encore/server-data.rst

@@ -16,13 +16,18 @@ Fetch this in JavaScript:
 
 .. code-block:: javascript
 
-    // jquery isn't required, but makes things simple
-    var $ = require('jquery');
-
-    $(document).ready(function() {
-        var isAuthenticated = $('.js-user-rating').data('is-authenticated');
+    document.addEventListener('DOMContentLoaded', function() {
+        var userRating = document.querySelector('.js-user-rating');
+        var isAuthenticated = userRating.dataset.isAuthenticated;
     });
 
+.. note::
+
+    When `accessing data attributes from JavaScript`_, the attribute names are
+    converted from dash-style to camelCase. For example, ``data-is-authenticated``
+    becomes ``isAuthenticated`` and ``data-number-of-reviews`` becomes
+    ``numberOfReviews``.
+
 There is no size limit for the value of the ``data-`` attributes, so you can
 store any content. In Twig, use the ``html_attr`` escaping strategy to avoid messing
 with HTML attributes. For example, if your ``User`` object has some ``getProfileData()``
@@ -33,3 +38,5 @@ method that returns an array, you could do the following:
     <div data-user-profile="{{ app.user ? app.user.profileData|json_encode|e('html_attr') : '' }}">
         <!-- ... -->
     </div>
+
+.. _`accessing data attributes from JavaScript`: https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes

http_cache/validation.rst

@@ -200,7 +200,7 @@ exposing a simple and efficient pattern::
 
             // create a Response with an ETag and/or a Last-Modified header
             $response = new Response();
-            $response->setETag($article->computeETag());
+            $response->setEtag($article->computeETag());
             $response->setLastModified($article->getPublishedAt());
 
             // Set response as public. Otherwise it will be private by default.

logging/formatter.rst

@@ -68,7 +68,7 @@ configure your handler to use it:
                 'file' => array(
                     'type'      => 'stream',
                     'level'     => 'debug',
-                    'formatter' => JsonFormatter::class',
+                    'formatter' => JsonFormatter::class,
                 ),
             ),
         ));

routing.rst

@@ -468,10 +468,6 @@ a slash. URLs matching this route might look like:
     Symfony provides you with a way to do this by leveraging service container
     parameters. Read more about this in ":doc:`/routing/service_container_parameters`".
 
-.. caution::
-
-    A route placeholder name cannot start with a digit and cannot be longer than 32 characters.
-
 Special Routing Parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

security/entity_provider.rst

@@ -130,13 +130,20 @@ with the following fields: ``id``, ``username``, ``password``,
                 $this->password,
                 // see section on salt below
                 // $this->salt
-            ) = unserialize($serialized);
+            ) = unserialize($serialized, ['allowed_classes' => false]);
         }
     }
 
 To make things shorter, some of the getter and setter methods aren't shown.
 But you can generate these manually or with your own IDE.
 
+.. caution::
+
+    In the example above, the User entity's table name is "app_users" because
+    "USER" is a SQL reserved word. If you wish to call your table name "user",
+    `it must be quoted with backticks`_ to avoid errors. The annotation should
+    look like ``@ORM\Table(name="`user`")``.
+
 Next, make sure to :ref:`create the database table <doctrine-creating-the-database-tables-schema>`:
 
 .. code-block:: terminal
@@ -539,3 +546,4 @@ or worry about it.
 
 .. _fixtures: https://symfony.com/doc/master/bundles/DoctrineFixturesBundle/index.html
 .. _FOSUserBundle: https://github.com/FriendsOfSymfony/FOSUserBundle
+.. _`it must be quoted with backticks`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html#quoting-reserved-words

serializer.rst

@@ -58,11 +58,11 @@ As well as the following normalizers:
 * :class:`Symfony\\Component\\Serializer\\Normalizer\\ObjectNormalizer` to
   handle typical data objects
 * :class:`Symfony\\Component\\Serializer\\Normalizer\\DateTimeNormalizer` for
-  objects implementing the :class:`DateTimeInterface` interface
+  objects implementing the :phpclass:`DateTimeInterface` interface
 * :class:`Symfony\\Component\\Serializer\\Normalizer\\DataUriNormalizer` to
-  transform :class:`SplFileInfo` objects in `Data URIs`_
+  transform :phpclass:`SplFileInfo` objects in `Data URIs`_
 * :class:`Symfony\\Component\\Serializer\\Normalizer\\JsonSerializableNormalizer`
-  to deal with objects implementing the :class:`JsonSerializable` interface
+  to deal with objects implementing the :phpclass:`JsonSerializable` interface
 * :class:`Symfony\\Component\\Serializer\\Normalizer\\ArrayDenormalizer` to
   denormalize arrays of objects using a format like `MyObject[]` (note the `[]` suffix)
 

service_container/3.3-di-changes.rst

@@ -81,32 +81,6 @@ what the file looks like in Symfony 4):
             </services>
         </container>
 
-    .. code-block:: php
-
-        // config/services.php
-        use Symfony\Component\DependencyInjection\Definition;
-
-        // To use as default template
-        $definition = new Definition();
-
-        $definition
-            ->setAutowired(true)
-            ->setAutoconfigured(true)
-            ->setPublic(false)
-        ;
-
-        $this->registerClasses($definition, 'App\\', '../src/*', '../src/{Entity,Migrations,Tests}');
-
-        // Changes default config
-        $definition
-            ->addTag('controller.service_arguments')
-        ;
-
-        // $this is a reference to the current loader
-        $this->registerClasses($definition, 'App\\Controller\\', '../src/Controller/*');
-
-        // add more services, or override services that need manual wiring
-
 This small bit of configuration contains a paradigm shift of how services
 are configured in Symfony.
 
@@ -152,22 +126,6 @@ thanks to the following config:
             </services>
         </container>
 
-    .. code-block:: php
-
-        // config/services.php
-        use Symfony\Component\DependencyInjection\Definition;
-
-        // To use as default template
-        $definition = new Definition();
-
-        $definition
-            ->setAutowired(true)
-            ->setAutoconfigured(true)
-            ->setPublic(false)
-        ;
-
-        $this->registerClasses($definition, 'App\\', '../src/*', '../src/{Entity,Migrations,Tests}');
-
 This means that every class in ``src/`` is *available* to be used as a
 service. And thanks to the ``_defaults`` section at the top of the file, all of
 these services are **autowired** and **private** (i.e. ``public: false``).
@@ -504,18 +462,6 @@ inherited from an abstract definition:
             </services>
         </container>
 
-    .. code-block:: php
-
-        // config/services.php
-        use App\Domain\LoaderInterface;
-
-        // ...
-
-        /* This method returns a child definition to define the default
-           configuration of the given class or interface */
-        $container->registerForAutoconfiguration(LoaderInterface::class)
-            ->addTag('app.domain_loader');
-
 What about Performance
 ----------------------
 

service_container/lazy_services.rst

@@ -53,8 +53,8 @@ You can mark the service as ``lazy`` by manipulating its definition:
 
         # config/services.yaml
         services:
-           App\Twig\AppExtension:
-             lazy:  true
+            App\Twig\AppExtension:
+                lazy:  true
 
     .. code-block:: xml
 

validation.rst

@@ -513,14 +513,6 @@ of the form fields::
         ;
     }
 
-The ``constraints`` option is only available if the ``ValidatorExtension``
-was enabled through the form factory builder::
-
-    Forms::createFormFactoryBuilder()
-        ->addExtension(new ValidatorExtension(Validation::createValidator()))
-        ->getFormFactory()
-    ;
-
 .. index::
    single: Validation; Constraint targets