Merge branch '4.4'

wouterj · wouterj · commit b24ba2513ef0 · 2019-11-09T13:46:16.000+01:00
* 4.4: [#12231] Explicitly name the options that can be configured through tags Explain how to add `from_transport` on `messenger.message_handler` tag Documented the new REMOTE_ADDR option [#12464] Minor changes Add Composer installation before step 1 for Symfony Flex Documentation for Bootstrap 4 custom switches
diff --git a/bundles/best_practices.rst b/bundles/best_practices.rst
@@ -277,6 +277,10 @@ following standardized instructions in your ``README.md`` file.
         Installation
         ============
 
+        Make sure Composer is installed globally, as explained in the
+        [installation chapter](https://getcomposer.org/doc/00-intro.md)
+        of the Composer documentation.
+
         Applications that use Symfony Flex
         ----------------------------------
 
@@ -298,10 +302,6 @@ following standardized instructions in your ``README.md`` file.
         $ composer require <package-name>
         ```
 
-        This command requires you to have Composer installed globally, as explained
-        in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
-        of the Composer documentation.
-
         ### Step 2: Enable the Bundle
 
         Then, enable the bundle by adding it to the list of registered bundles
@@ -321,7 +321,9 @@ following standardized instructions in your ``README.md`` file.
         Installation
         ============
 
-        Applications that use Symfony Flex
+        Make sure Composer is installed globally, as explained in the
+        `installation chapter`_ of the Composer documentation.
+
         ----------------------------------
 
         Open a command console, enter your project directory and execute:
@@ -343,9 +345,6 @@ following standardized instructions in your ``README.md`` file.
 
             $ composer require <package-name>
 
-        This command requires you to have Composer installed globally, as explained
-        in the `installation chapter`_ of the Composer documentation.
-
         Step 2: Enable the Bundle
         ~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/deployment/proxies.rst b/deployment/proxies.rst
@@ -65,13 +65,18 @@ In this case, you'll need to - *very carefully* - trust *all* proxies.
 
        // ...
        Request::setTrustedProxies(
-           // trust *all* requests
-           ['127.0.0.1', $request->server->get('REMOTE_ADDR')],
+           // trust *all* requests (the 'REMOTE_ADDR' string is replaced at
+           // run time by $_SERVER['REMOTE_ADDR'])
+           ['127.0.0.1', 'REMOTE_ADDR'],
 
            // if you're using ELB, otherwise use a constant from above
            Request::HEADER_X_FORWARDED_AWS_ELB
        );
 
+.. versionadded:: 4.4
+
+    The support for the ``REMOTE_ADDR`` option was introduced in Symfony 4.4.
+
 That's it! It's critical that you prevent traffic from all non-trusted sources.
 If you allow outside traffic, they could "spoof" their true IP address and
 other information.
diff --git a/form/bootstrap4.rst b/form/bootstrap4.rst
@@ -91,14 +91,22 @@ for **all** users.
 Custom Forms
 ------------
 
+.. versionadded:: 4.4
+
+    Support for the ``switch-custom`` class was introduced in Symfony 4.4.
+
 Bootstrap 4 has a feature called "`custom forms`_". You can enable that on your
-Symfony Form ``RadioType`` and ``CheckboxType`` by adding a class called ``radio-custom``
-and ``checkbox-custom`` respectively.
+Symfony Form ``RadioType`` and ``CheckboxType`` by adding some classes to the label:
+
+* For a `custom radio`_, use ``radio-custom``;
+* For a `custom checkbox`_, use ``checkbox-custom``;
+* For having a `switch instead of a checkbox`_, use ``switch-custom``.
 
 .. code-block:: twig
 
     {{ form_row(form.myRadio, {label_attr: {class: 'radio-custom'} }) }}
     {{ form_row(form.myCheckbox, {label_attr: {class: 'checkbox-custom'} }) }}
+    {{ form_row(form.myCheckbox, {label_attr: {class: 'switch-custom'} }) }}
 
 Labels and Errors
 -----------------
@@ -112,4 +120,7 @@ is a strong connection between the error and its ``<input>``, as required by the
 `WCAG 2.0 standard`_.
 
 .. _`WCAG 2.0 standard`: https://www.w3.org/TR/WCAG20/
-.. _`custom forms`: https://getbootstrap.com/docs/4.1/components/forms/#custom-forms
+.. _`custom forms`: https://getbootstrap.com/docs/4.3/components/forms/#custom-forms
+.. _`custom radio`: https://getbootstrap.com/docs/4.3/components/forms/#radios
+.. _`custom checkbox`: https://getbootstrap.com/docs/4.3/components/forms/#checkboxes
+.. _`switch instead of a checkbox`: https://getbootstrap.com/docs/4.3/components/forms/#switches
diff --git a/messenger.rst b/messenger.rst
@@ -1016,8 +1016,6 @@ by tagging the handler service with ``messenger.message_handler``
                         # only needed if can't be guessed by type-hint
                         handles: App\Message\SmsNotification
 
-                        # options returned by getHandledMessages() are supported here
-
     .. code-block:: xml
 
         <!-- config/services.xml -->
@@ -1029,7 +1027,9 @@ by tagging the handler service with ``messenger.message_handler``
 
             <services>
                 <service id="App\MessageHandler\SmsNotificationHandler">
-                   <tag name="messenger.message_handler"/>
+                     <!-- handles is only needed if it can't be guessed by type-hint -->
+                     <tag name="messenger.message_handler"
+                          handles="App\Message\SmsNotification"/>
                 </service>
             </services>
         </container>
@@ -1038,9 +1038,26 @@ by tagging the handler service with ``messenger.message_handler``
 
         // config/services.php
         use App\MessageHandler\SmsNotificationHandler;
+        use App\Message\SmsNotification;
 
         $container->register(SmsNotificationHandler::class)
-            ->addTag('messenger.message_handler');
+            ->addTag('messenger.message_handler', [
+                // only needed if can't be guessed by type-hint
+                'handles' => SmsNotification::class,
+            ]);
+
+
+Possible options to configure with tags are:
+
+* ``bus``
+* ``from_transport``
+* ``handles``
+* ``method``
+* ``priority``
+
+.. versionadded:: 4.4
+    
+    The ability to specify ``from_transport`` on the tag, was added in Symfony 4.4.
 
 Handler Subscriber & Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
