Merge branch '3.4' into 4.0

weaverryan · weaverryan · commit 6c54c7819e3c · 2017-11-27T14:28:02.000-05:00
* 3.4:
  Update event_listeners_subscribers.rst
  Update event_listeners_subscribers.rst
  add missing link target for Ansistrano
  Corrected a spelling error.
  Update Custom UsernamePasswordToken Authenticator
  fixing ref
  removing some deploy strategies + adding &amp; reordering
  Removing limit_metadata_writes
  Removing use_strict_mode docs, as this feature is deprecated in 3.4
diff --git a/_build/redirection_map b/_build/redirection_map
@@ -200,7 +200,7 @@
 /cookbook/psr7 /components/psr7
 /cookbook/request/index /request
 /cookbook/request/load_balancer_reverse_proxy /deployment/proxies
-/cookbook/request/mime_type /reference/configuration/framework#formats
+/cookbook/request/mime_type /reference/configuration/framework
 /cookbook/routing/conditions /routing/conditions
 /cookbook/routing/custom_route_loader /routing/custom_route_loader
 /cookbook/routing/debug /routing/debug
@@ -250,7 +250,8 @@
 /cookbook/service_container/shared /service_container/shared
 /cookbook/session/avoid_session_start /session/avoid_session_start
 /cookbook/session/index /session
-/cookbook/session/limit_metadata_writes /session/limit_metadata_writes
+/cookbook/session/limit_metadata_writes /reference/configuration/framework
+/session/limit_metadata_writes /reference/configuration/framework
 /cookbook/session/locale_sticky_session /session/locale_sticky_session
 /cookbook/session/php_bridge /session/php_bridge
 /cookbook/session/proxy_examples /session/proxy_examples
diff --git a/deployment.rst b/deployment.rst
@@ -77,13 +77,15 @@ Using Build Scripts and other Tools
 There are also tools to help ease the pain of deployment. Some of them have been
 specifically tailored to the requirements of Symfony.
 
-`Capistrano`_ with `Symfony plugin`_
-    `Capistrano`_ is a remote server automation and deployment tool written in Ruby.
-    `Symfony plugin`_ is a plugin to ease Symfony related tasks, inspired by `Capifony`_
-    (which works only with Capistrano 2).
+`EasyDeployBundle`_
+    A Symfony bundle that adds easy deploy tools to your application.
 
-`sf2debpkg`_
-    Helps you build a native Debian package for your Symfony project.
+`Deployer`_
+    This is another native PHP rewrite of Capistrano, with some ready recipes for
+    Symfony.
+
+`Ansistrano`_
+    An Ansible role that allows you to configure a powerful deploy via YAML files.
 
 `Magallanes`_
     This Capistrano-like deployment tool is built in PHP, and may be easier
@@ -93,13 +95,14 @@ specifically tailored to the requirements of Symfony.
     This Python-based library provides a basic suite of operations for executing
     local or remote shell commands and uploading/downloading files.
 
-`Deployer`_
-    This is another native PHP rewrite of Capistrano, with some ready recipes for
-    Symfony.
+`Capistrano`_ with `Symfony plugin`_
+    `Capistrano`_ is a remote server automation and deployment tool written in Ruby.
+    `Symfony plugin`_ is a plugin to ease Symfony related tasks, inspired by `Capifony`_
+    (which works only with Capistrano 2).
+
+`sf2debpkg`_
+    Helps you build a native Debian package for your Symfony project.
 
-Bundles
-    There are some `bundles that add deployment features`_ directly into your
-    Symfony console.
 
 Basic scripting
     You can of course use shell, `Ant`_ or any other build tool to script
@@ -246,9 +249,9 @@ Learn More
 .. _`Capistrano`: http://capistranorb.com/
 .. _`sf2debpkg`: https://github.com/liip/sf2debpkg
 .. _`Fabric`: http://www.fabfile.org/
+.. _`Ansistrano`: https://ansistrano.com/
 .. _`Magallanes`: https://github.com/andres-montanez/Magallanes
 .. _`Ant`: http://blog.sznapka.pl/deploying-symfony2-applications-with-ant
-.. _`bundles that add deployment features`: https://github.com/search?utf8=✓&q=topic%3Asymfony-bundle+topic%3Adeploy&type=Repositories&ref=searchresults
 .. _`Memcached`: http://memcached.org/
 .. _`Redis`: http://redis.io/
 .. _`Symfony plugin`: https://github.com/capistrano/symfony/
@@ -258,3 +261,4 @@ Learn More
 .. _`platform.sh`: https://docs.platform.sh/frameworks/symfony.html
 .. _`Azure`: https://azure.microsoft.com/en-us/develop/php/
 .. _`fortrabbit`: https://help.fortrabbit.com/install-symfony
+.. _`EasyDeployBundle`: https://github.com/EasyCorp/easy-deploy-bundle
diff --git a/doctrine/event_listeners_subscribers.rst b/doctrine/event_listeners_subscribers.rst
@@ -102,14 +102,14 @@ a ``postPersist()`` method, which will be called when the event is dispatched::
     {
         public function postPersist(LifecycleEventArgs $args)
         {
-            $object = $args->getObject();
+            $entity = $args->getEntity();
 
             // only act on some "Product" entity
-            if (!$object instanceof Product) {
+            if (!$entity instanceof Product) {
                 return;
             }
 
-            $objectManager = $args->getObjectManager();
+            $entityManager = $args->getEntityManager();
             // ... do something with the Product
         }
     }
@@ -166,7 +166,7 @@ interface and have an event method for each event it subscribes to::
 
         public function index(LifecycleEventArgs $args)
         {
-            $entity = $args->getObject();
+            $entity = $args->getEntity();
 
             // perhaps you only want to act on some "Product" entity
             if ($entity instanceof Product) {
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -66,7 +66,6 @@ Configuration
     * `gc_divisor`_
     * `gc_probability`_
     * `gc_maxlifetime`_
-    * `use_strict_mode`_
     * `save_path`_
     * `metadata_update_threshold`_
 * `assets`_
@@ -798,17 +797,6 @@ This determines the number of seconds after which data will be seen as "garbage"
 and potentially cleaned up. Garbage collection may occur during session
 start and depends on `gc_divisor`_ and `gc_probability`_.
 
-use_strict_mode
-...............
-
-**type**: ``boolean`` **default**: ``false``
-
-This specifies whether the session module will use the strict session id mode.
-If this mode is enabled, the module does not accept uninitialized session IDs.
-If an uninitialized session ID is sent from browser, a new session ID is sent
-to browser. Applications are protected from session fixation via session
-adoption with strict mode.
-
 save_path
 .........
 
@@ -855,18 +843,19 @@ setting the value to ``null``:
             ),
         ));
 
+.. _reference-session-metadata-update-threshold:
+
 metadata_update_threshold
 .........................
 
 **type**: ``integer`` **default**: ``0``
 
-This is how many seconds to wait between two session metadata updates. It will
-also prevent the session handler to write if the session has not changed.
-
-.. seealso::
+This is how many seconds to wait between updating/writing the session metadata. This
+can be useful if, for some reason, you want to limit the frequency at which the
+session persists.
 
-    You can see an example of the usage of this in
-    :doc:`/session/limit_metadata_writes`.
+Starting in Symfony 3.4, session data is *only* written when the session data has
+changed. Previously, you needed to set this option to avoid that behavior.
 
 assets
 ~~~~~~
diff --git a/security/custom_password_authenticator.rst b/security/custom_password_authenticator.rst
@@ -61,6 +61,7 @@ the user::
                     // (so don't put any un-trusted messages / error strings here)
                     throw new CustomUserMessageAuthenticationException(
                         'You can only log in between 2 and 4!',
+                        array(), // Message Data
                         412 // HTTP 412 Precondition Failed
                     );
                 }
diff --git a/session/limit_metadata_writes.rst b/session/limit_metadata_writes.rst
diff --git a/workflow/state-machines.rst b/workflow/state-machines.rst
@@ -14,7 +14,7 @@ machine.
 Example of a State Machine
 --------------------------
 
-A pull request starts in an intial "start" state, a state for e.g. running
+A pull request starts in an initial "start" state, a state for e.g. running
 tests on Travis. When this is finished, the pull request is in the "review"
 state, where contributors can require changes, reject or accept the
 pull request. At any time, you can also "update" the pull request, which

Original file line number	Diff line number	Diff line change
@@ -102,14 +102,14 @@ a ``postPersist()`` method, which will be called when the event is dispatched::
`102`	`102`	`{`
`103`	`103`	`public function postPersist(LifecycleEventArgs $args)`
`104`	`104`	`{`
`105`		`- $object = $args->getObject();`
	`105`	`+ $entity = $args->getEntity();`
`106`	`106`
`107`	`107`	`// only act on some "Product" entity`
`108`		`- if (!$object instanceof Product) {`
	`108`	`+ if (!$entity instanceof Product) {`
`109`	`109`	`return;`
`110`	`110`	`}`
`111`	`111`
`112`		`- $objectManager = $args->getObjectManager();`
	`112`	`+ $entityManager = $args->getEntityManager();`
`113`	`113`	`// ... do something with the Product`
`114`	`114`	`}`
`115`	`115`	`}`
`@@ -166,7 +166,7 @@ interface and have an event method for each event it subscribes to::`
`166`	`166`
`167`	`167`	`public function index(LifecycleEventArgs $args)`
`168`	`168`	`{`
`169`		`- $entity = $args->getObject();`
	`169`	`+ $entity = $args->getEntity();`
`170`	`170`
`171`	`171`	`// perhaps you only want to act on some "Product" entity`
`172`	`172`	`if ($entity instanceof Product) {`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ the user::`
`61`	`61`	`// (so don't put any un-trusted messages / error strings here)`
`62`	`62`	`throw new CustomUserMessageAuthenticationException(`
`63`	`63`	`'You can only log in between 2 and 4!',`
	`64`	`+ array(), // Message Data`
`64`	`65`	`412 // HTTP 412 Precondition Failed`
`65`	`66`	`);`
`66`	`67`	`}`