Merge branch '3.4' into 4.0

javiereguiluz · javiereguiluz · commit 224138ed86d2 · 2018-07-30T16:05:57.000+02:00
* 3.4:
  Remove useless $request
  Improve the docs about custom form theme config
  Use callable classes for custom Monolog processors
  Mentioned the audit_trail workflow option
  Update custom_password_authenticator.rst
  Remove example of register a service where its id match to its class
diff --git a/form/form_themes.rst b/form/form_themes.rst
@@ -179,6 +179,7 @@ file:
         # config/packages/twig.yaml
         twig:
             form_themes:
+                - '...'
                 - 'form/fields.html.twig'
             # ...
 
@@ -194,6 +195,7 @@ file:
                 http://symfony.com/schema/dic/twig http://symfony.com/schema/dic/twig/twig-1.0.xsd">
 
             <twig:config>
+                <twig:theme>...</twig:theme>
                 <twig:theme>form/fields.html.twig</twig:theme>
                 <!-- ... -->
             </twig:config>
@@ -204,11 +206,17 @@ file:
         // config/packages/twig.php
         $container->loadFromExtension('twig', array(
             'form_themes' => array(
+                '...',
                 'form/fields.html.twig',
             ),
             // ...
         ));
 
+.. note::
+
+    Add your custom theme at the end of the ``form_themes`` list because each
+    theme overrides all the previous themes.
+
 Any blocks inside the ``fields.html.twig`` template are now used globally
 to define form output.
 
diff --git a/logging/processors.rst b/logging/processors.rst
@@ -30,7 +30,7 @@ using a processor::
             $this->session = $session;
         }
 
-        public function processRecord(array $record)
+        public function __invoke(array $record)
         {
             if (!$this->session->isStarted()) {
                 return $record;
@@ -62,7 +62,7 @@ information:
 
             App\Logger\SessionRequestProcessor:
                 tags:
-                    - { name: monolog.processor, method: processRecord }
+                    - { name: monolog.processor }
 
     .. code-block:: xml
 
@@ -84,7 +84,7 @@ information:
                 </service>
 
                 <service id="App\Logger\SessionRequestProcessor">
-                    <tag name="monolog.processor" method="processRecord" />
+                    <tag name="monolog.processor" />
                 </service>
             </services>
         </container>
@@ -173,7 +173,7 @@ the ``monolog.processor`` tag:
         services:
             App\Logger\SessionRequestProcessor:
                 tags:
-                    - { name: monolog.processor, method: processRecord, handler: main }
+                    - { name: monolog.processor, handler: main }
 
     .. code-block:: xml
 
@@ -189,7 +189,7 @@ the ``monolog.processor`` tag:
 
             <services>
                 <service id="App\Logger\SessionRequestProcessor">
-                    <tag name="monolog.processor" method="processRecord" handler="main" />
+                    <tag name="monolog.processor" handler="main" />
                 </service>
             </services>
         </container>
@@ -201,7 +201,7 @@ the ``monolog.processor`` tag:
         // ...
         $container
             ->register(SessionRequestProcessor::class)
-            ->addTag('monolog.processor', array('method' => 'processRecord', 'handler' => 'main'));
+            ->addTag('monolog.processor', array('handler' => 'main'));
 
 Registering Processors per Channel
 ----------------------------------
@@ -217,7 +217,7 @@ the ``monolog.processor`` tag:
         services:
             App\Logger\SessionRequestProcessor:
                 tags:
-                    - { name: monolog.processor, method: processRecord, channel: main }
+                    - { name: monolog.processor, channel: main }
 
     .. code-block:: xml
 
@@ -233,7 +233,7 @@ the ``monolog.processor`` tag:
 
             <services>
                 <service id="App\Logger\SessionRequestProcessor">
-                    <tag name="monolog.processor" method="processRecord" channel="main" />
+                    <tag name="monolog.processor" channel="main" />
                 </service>
             </services>
         </container>
@@ -245,4 +245,4 @@ the ``monolog.processor`` tag:
         // ...
         $container
             ->register(SessionRequestProcessor::class)
-            ->addTag('monolog.processor', array('method' => 'processRecord', 'channel' => 'main'));
+            ->addTag('monolog.processor', array('channel' => 'main'));
diff --git a/security/custom_password_authenticator.rst b/security/custom_password_authenticator.rst
@@ -63,7 +63,7 @@ the user::
                 if ('' === ($givenPassword = $token->getCredentials())) {
                     throw new BadCredentialsException('The given password cannot be empty.');
                 }
-                if (!$this->encoderFactory->getEncoder($user)->isPasswordValid($user->getPassword(), $givenPassword, $user->getSalt())) {
+                if (!$this->encoder->isPasswordValid($user->getPassword(), $givenPassword, $user->getSalt())) {
                     throw new BadCredentialsException('The given password is invalid.');
                 }
             }
diff --git a/security/form_login_setup.rst b/security/form_login_setup.rst
@@ -91,15 +91,14 @@ configuration (``login``):
         // src/Controller/SecurityController.php
 
         // ...
-        use Symfony\Component\HttpFoundation\Request;
         use Symfony\Component\Routing\Annotation\Route;
 
         class SecurityController extends Controller
         {
             /**
              * @Route("/login", name="login")
              */
-            public function login(Request $request)
+            public function login()
             {
             }
         }
@@ -144,7 +143,7 @@ Great! Next, add the logic to ``login()`` that displays the login form::
     // src/Controller/SecurityController.php
     use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
 
-    public function login(Request $request, AuthenticationUtils $authenticationUtils)
+    public function login(AuthenticationUtils $authenticationUtils)
     {
         // get the login error if there is one
         $error = $authenticationUtils->getLastAuthenticationError();
diff --git a/service_container/definitions.rst b/service_container/definitions.rst
@@ -38,9 +38,6 @@ There are some helpful methods for working with the service definitions::
     // shortcut for the previous method
     $container->register('app.number_generator', \App\NumberGenerator::class);
 
-    // or create a service whose id matches its class
-    $container->register(\App\NumberGenerator::class);
-
 Working with a Definition
 -------------------------
 
diff --git a/workflow/usage.rst b/workflow/usage.rst
@@ -40,6 +40,7 @@ like this:
             workflows:
                 blog_publishing:
                     type: 'workflow' # or 'state_machine'
+                    audit_trail: 'enabled'
                     marking_store:
                         type: 'multiple_state' # or 'single_state'
                         arguments:
@@ -75,7 +76,7 @@ like this:
         >
 
             <framework:config>
-                <framework:workflow name="blog_publishing" type="workflow">
+                <framework:workflow name="blog_publishing" type="workflow" audit_trail="enabled">
                     <framework:marking-store type="single_state">
                       <framework:argument>currentPlace</framework:argument>
                     </framework:marking-store>
@@ -119,6 +120,7 @@ like this:
             'workflows' => array(
                 'blog_publishing' => array(
                     'type' => 'workflow', // or 'state_machine'
+                    'audit_trail' => 'enabled',
                     'marking_store' => array(
                         'type' => 'multiple_state', // or 'single_state'
                         'arguments' => array('currentPlace')
@@ -170,6 +172,11 @@ like this:
     value ``marking``) attributes of the ``marking_store`` option are optional.
     If omitted, their default values will be used.
 
+.. tip::
+
+    Setting the ``audit_trail`` option to ``enabled`` makes the application
+    generate detailed log messages for the workflow activity.
+
 Using a Workflow
 ----------------
 

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ the user::`
`63`	`63`	`if ('' === ($givenPassword = $token->getCredentials())) {`
`64`	`64`	`throw new BadCredentialsException('The given password cannot be empty.');`
`65`	`65`	`}`
`66`		`- if (!$this->encoderFactory->getEncoder($user)->isPasswordValid($user->getPassword(), $givenPassword, $user->getSalt())) {`
	`66`	`+ if (!$this->encoder->isPasswordValid($user->getPassword(), $givenPassword, $user->getSalt())) {`
`67`	`67`	`throw new BadCredentialsException('The given password is invalid.');`
`68`	`68`	`}`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
@@ -91,15 +91,14 @@ configuration (``login``):
`91`	`91`	`// src/Controller/SecurityController.php`
`92`	`92`
`93`	`93`	`// ...`
`94`		`- use Symfony\Component\HttpFoundation\Request;`
`95`	`94`	`use Symfony\Component\Routing\Annotation\Route;`
`96`	`95`
`97`	`96`	`class SecurityController extends Controller`
`98`	`97`	`{`
`99`	`98`	`/**`
`100`	`99`	`* @Route("/login", name="login")`
`101`	`100`	`*/`
`102`		`- public function login(Request $request)`
	`101`	`+ public function login()`
`103`	`102`	`{`
`104`	`103`	`}`
`105`	`104`	`}`
@@ -144,7 +143,7 @@ Great! Next, add the logic to ``login()`` that displays the login form::
`144`	`143`	`// src/Controller/SecurityController.php`
`145`	`144`	`use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;`
`146`	`145`
`147`		`- public function login(Request $request, AuthenticationUtils $authenticationUtils)`
	`146`	`+ public function login(AuthenticationUtils $authenticationUtils)`
`148`	`147`	`{`
`149`	`148`	`// get the login error if there is one`
`150`	`149`	`$error = $authenticationUtils->getLastAuthenticationError();`