upgrade

vendor/friendsofsymfony/user-bundle/Resources/doc/canonicalizer.rst

@@ -0,0 +1,47 @@
+FOSUserBundle Canonicalization
+==============================
+
+FOSUserBundle stores canonicalized versions of the username and the email
+which are used when querying and checking for uniqueness.
+The default implementation simply makes them case-insensitive to avoid having
+users whose username only differs because of the case. It uses :phpfunction:`mb_convert_case`
+to achieve this result.
+
+.. caution::
+
+    If you do not have the mbstring extension installed you will need to
+    define your own canonicalizer.
+
+Replacing the canonicalizers
+----------------------------
+
+If you want to change the way the canonical fields are populated, simply
+create a class implementing ``FOS\UserBundle\Util\CanonicalizerInterface``
+and register it as a service:
+
+.. code-block:: yaml
+
+    # app/config/services.yml
+    services:
+        app.my_canonicalizer:
+            class: AppBundle\Util\CustomCanonicalizer
+            public: false
+
+
+You can now configure FOSUserBundle to use your own implementation:
+
+.. code-block:: yaml
+
+    # app/config/config.yml
+    fos_user:
+        # ...
+        service:
+            email_canonicalizer:    app.my_canonicalizer
+            username_canonicalizer: app.my_canonicalizer
+
+You can of course use different services for each field if you don't want
+to use the same logic.
+
+.. note::
+
+    The default implementation has the id ``fos_user.util.canonicalizer.default``.