minor #14349 Fix missing namespace and other wrong wording from Security and Serializer context (TheGarious)

javiereguiluz · javiereguiluz · commit a20f40a57954 · 2020-10-22T17:39:44.000+02:00
This PR was submitted for the master branch but it was squashed and merged into the 4.4 branch instead. Discussion ---------- Fix missing namespace and other wrong wording from Security and Serializer context  Commits ------- 22345e0 Fix missing namespace and other wrong wording from Security and Serializer context
diff --git a/security/access_denied_handler.rst b/security/access_denied_handler.rst
@@ -13,6 +13,7 @@ This interface defines one method called ``handle()`` where you can implement wh
 logic that should run when access is denied for the current user (e.g. send a
 mail, log a message, or generally return a custom response)::
 
+    // src/Security/AccessDeniedHandler.php
     namespace App\Security;
 
     use Symfony\Component\HttpFoundation\Request;
diff --git a/security/csrf.rst b/security/csrf.rst
@@ -83,6 +83,9 @@ protected against CSRF attacks.
 By default Symfony adds the CSRF token in a hidden field called ``_token``, but
 this can be customized on a form-by-form basis::
 
+    // src/Form/TaskType.php
+    namespace App\Form;
+    
     // ...
     use App\Entity\Task;
     use Symfony\Component\OptionsResolver\OptionsResolver;
diff --git a/security/custom_authentication_provider.rst b/security/custom_authentication_provider.rst
@@ -538,6 +538,11 @@ can have different timeout lengths.
 You will first need to edit ``WsseFactory`` and define the new option in
 the ``addConfiguration()`` method::
 
+    // src/DependencyInjection/Security/Factory/WsseFactory.php
+    namespace App\DependencyInjection\Security\Factory;
+
+    // ...
+
     class WsseFactory implements SecurityFactoryInterface
     {
         // ...
@@ -556,6 +561,9 @@ contain a ``lifetime`` key, set to 5 minutes (300 seconds) unless otherwise
 set in the configuration. Pass this argument to your authentication provider
 in order to put it to use::
 
+    // src/DependencyInjection/Security/Factory/WsseFactory.php
+    namespace App\DependencyInjection\Security\Factory;
+    
     use App\Security\Authentication\Provider\WsseProvider;
 
     class WsseFactory implements SecurityFactoryInterface
diff --git a/security/form_login.rst b/security/form_login.rst
@@ -93,6 +93,7 @@ configuration (``login``):
     .. code-block:: php-annotations
 
         // src/Controller/SecurityController.php
+        namespace App\Controller;
 
         // ...
         use Symfony\Component\Routing\Annotation\Route;
diff --git a/security/form_login_setup.rst b/security/form_login_setup.rst
@@ -477,6 +477,7 @@ If you also want to apply this behavior to public pages, you can create an
 :doc:`event subscriber </event_dispatcher>` to set the target path manually
 whenever the user browses a page::
 
+    // src/EventSubscriber/RequestSubscriber.php
     namespace App\EventSubscriber;
 
     use Symfony\Component\EventDispatcher\EventSubscriberInterface;
diff --git a/security/guard_authentication.rst b/security/guard_authentication.rst
@@ -28,6 +28,8 @@ your ``User`` class (the ``make:entity`` command is a good way to do this):
 .. code-block:: diff
 
     // src/Entity/User.php
+    namespace App\Entity;
+
     // ...
 
     class User implements UserInterface
@@ -411,6 +413,8 @@ You can throw this from ``getCredentials()``, ``getUser()`` or ``checkCredential
 to cause a failure::
 
     // src/Security/TokenAuthenticator.php
+    namespace App\Security;
+
     // ...
 
     use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
@@ -453,8 +457,9 @@ completes registration. To do that, use your authenticator and a service called
 ``GuardAuthenticatorHandler``::
 
     // src/Controller/RegistrationController.php
+    namespace App\Controller;
+    
     // ...
-
     use App\Security\LoginFormAuthenticator;
     use Symfony\Component\HttpFoundation\Request;
     use Symfony\Component\Security\Guard\GuardAuthenticatorHandler;
diff --git a/security/impersonating_user.rst b/security/impersonating_user.rst
@@ -113,6 +113,9 @@ stored in the token storage will be a ``SwitchUserToken`` instance. Use the
 following snippet to obtain the original token which gives you access to
 the impersonator user::
 
+    // src/Service/SomeService.php
+    namespace App\Service;
+
     use Symfony\Component\Security\Core\Authentication\Token\SwitchUserToken;
     use Symfony\Component\Security\Core\Security;
     // ...
@@ -256,6 +259,7 @@ be called):
 Then, create a voter class that responds to this role and includes whatever custom
 logic you want::
 
+    // src/Service/Voter/SwitchToCustomerVoter.php
     namespace App\Security\Voter;
 
     use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
diff --git a/security/json_login_setup.rst b/security/json_login_setup.rst
@@ -65,6 +65,7 @@ The next step is to configure a route in your app matching this path:
     .. code-block:: php-annotations
 
         // src/Controller/SecurityController.php
+        namespace App\Controller;
 
         // ...
         use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
diff --git a/security/named_encoders.rst b/security/named_encoders.rst
@@ -117,8 +117,8 @@ to use it, the class must implement
 The interface requires one method - ``getEncoderName()`` - which should return
 the name of the encoder to use::
 
-    // src/Acme/UserBundle/Entity/User.php
-    namespace Acme\UserBundle\Entity;
+    // src/Entity/User.php
+    namespace App\Entity;
 
     use Symfony\Component\Security\Core\Encoder\EncoderAwareInterface;
     use Symfony\Component\Security\Core\User\UserInterface;
diff --git a/serializer/custom_encoders.rst b/serializer/custom_encoders.rst
@@ -19,6 +19,7 @@ Imagine you want to serialize and deserialize YAML. For that you'll have to
 create your own encoder that uses the
 :doc:`Yaml Component </components/yaml>`::
 
+    // src/Serializer/YamlEncoder.php
     namespace App\Serializer;
 
     use Symfony\Component\Serializer\Encoder\DecoderInterface;
diff --git a/serializer/custom_normalizer.rst b/serializer/custom_normalizer.rst
@@ -17,6 +17,7 @@ process. For that you'll have to create your own normalizer. But it's usually
 preferable to let Symfony normalize the object, then hook into the normalization
 to customize the normalized data. To do that, leverage the ``ObjectNormalizer``::
 
+    // src/Serializer/TopicNormalizer.php
     namespace App\Serializer;
 
     use App\Entity\Topic;

Original file line number	Diff line number	Diff line change
@@ -13,6 +13,7 @@ This interface defines one method called ``handle()`` where you can implement wh
`13`	`13`	`logic that should run when access is denied for the current user (e.g. send a`
`14`	`14`	`mail, log a message, or generally return a custom response)::`
`15`	`15`
	`16`	`+ // src/Security/AccessDeniedHandler.php`
`16`	`17`	`namespace App\Security;`
`17`	`18`
`18`	`19`	`use Symfony\Component\HttpFoundation\Request;`