Add more details to TypeInfo documentation

.doctor-rst.yaml

@@ -23,6 +23,8 @@ rules:
     forbidden_directives:
         directives:
             - '.. index::'
+            - directive: '.. caution::'
+              replacements: ['.. warning::', '.. danger::']
     indention: ~
     lowercase_as_in_use_statements: ~
     max_blank_lines:
@@ -46,6 +48,7 @@ rules:
     no_namespace_after_use_statements: ~
     no_php_open_tag_in_code_block_php_directive: ~
     no_space_before_self_xml_closing_tag: ~
+    non_static_phpunit_assertions: ~
     only_backslashes_in_namespace_in_php_code_block: ~
     only_backslashes_in_use_statements_in_php_code_block: ~
     ordered_use_statements: ~
@@ -99,7 +102,6 @@ whitelist:
         - '#. The most important config file is ``app/config/services.yml``, which now is'
         - 'The bin/console Command'
         - '.. _`LDAP injection`: http://projects.webappsec.org/w/page/13246947/LDAP%20Injection'
-        - '.. versionadded:: 2.7.2' # Doctrine
         - '.. versionadded:: 2.8.0' # Doctrine
         - '.. versionadded:: 1.9.0' # Encore
         - '.. versionadded:: 1.18' # Flex in setup/upgrade_minor.rst

.github/workflows/ci.yaml

@@ -73,7 +73,7 @@ jobs:
                     key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }}
 
             -   name: "Run DOCtor-RST"
-                uses: docker://oskarstark/doctor-rst:1.62.3
+                uses: docker://oskarstark/doctor-rst:1.64.0
                 with:
                     args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache
 

_build/redirection_map

@@ -525,8 +525,7 @@
 /testing/functional_tests_assertions /testing#testing-application-assertions
 /components https://symfony.com/components
 /components/index https://symfony.com/components
-/serializer/normalizers /components/serializer#normalizers
-/components/serializer#component-serializer-attributes-groups-annotations /components/serializer#component-serializer-attributes-groups-attributes
+/serializer/normalizers /serializer#serializer-built-in-normalizers
 /logging/monolog_regex_based_excludes /logging/monolog_exclude_http_codes
 /security/named_encoders /security/named_hashers
 /components/inflector /string#inflector
@@ -572,3 +571,5 @@
 /doctrine/registration_form /security#security-make-registration-form
 /form/form_dependencies /form/create_custom_field_type
 /doctrine/reverse_engineering /doctrine#doctrine-adding-mapping
+/components/serializer /serializer
+/serializer/custom_encoder /serializer/encoders#serializer-custom-encoder

bundles.rst

@@ -3,7 +3,7 @@
 The Bundle System
 =================
 
-.. caution::
+.. warning::
 
     In Symfony versions prior to 4.0, it was recommended to organize your own
     application code using bundles. This is :ref:`no longer recommended <best-practice-no-application-bundles>` and bundles
@@ -58,7 +58,7 @@ Start by creating a new class called ``AcmeBlogBundle``::
     {
     }
 
-.. caution::
+.. warning::
 
     If your bundle must be compatible with previous Symfony versions you have to
     extend from the :class:`Symfony\\Component\\HttpKernel\\Bundle\\Bundle` instead.
@@ -118,7 +118,7 @@ to be adjusted if needed:
 
 .. _bundles-legacy-directory-structure:
 
-.. caution::
+.. warning::
 
     The recommended bundle structure was changed in Symfony 5, read the
     `Symfony 4.4 bundle documentation`_ for information about the old

bundles/best_practices.rst

@@ -246,7 +246,7 @@ with Symfony Flex to install a specific Symfony version:
     # recommended to have a better output and faster download time)
     composer update --prefer-dist --no-progress
 
-.. caution::
+.. warning::
 
     If you want to cache your Composer dependencies, **do not** cache the
     ``vendor/`` directory as this has side-effects. Instead cache

bundles/extension.rst

@@ -200,7 +200,7 @@ Patterns are transformed into the actual class namespaces using the classmap
 generated by Composer. Therefore, before using these patterns, you must generate
 the full classmap executing the ``dump-autoload`` command of Composer.
 
-.. caution::
+.. warning::
 
     This technique can't be used when the classes to compile use the ``__DIR__``
     or ``__FILE__`` constants, because their values will change when loading

bundles/override.rst

@@ -19,7 +19,7 @@ For example, to override the ``templates/registration/confirmed.html.twig``
 template from the AcmeUserBundle, create this template:
 ``<your-project>/templates/bundles/AcmeUserBundle/registration/confirmed.html.twig``
 
-.. caution::
+.. warning::
 
     If you add a template in a new location, you *may* need to clear your
     cache (``php bin/console cache:clear``), even if you are in debug mode.

cache.rst

@@ -829,7 +829,7 @@ Then, register the ``SodiumMarshaller`` service using this key:
             //->addArgument(['env(base64:CACHE_DECRYPTION_KEY)', 'env(base64:OLD_CACHE_DECRYPTION_KEY)'])
             ->addArgument(new Reference('.inner'));
 
-.. caution::
+.. danger::
 
     This will encrypt the values of the cache items, but not the cache keys. Be
     careful not to leak sensitive data in the keys.

components/cache/adapters/apcu_adapter.rst

@@ -5,7 +5,7 @@ This adapter is a high-performance, shared memory cache. It can *significantly*
 increase an application's performance, as its cache contents are stored in shared
 memory, a component appreciably faster than many others, such as the filesystem.
 
-.. caution::
+.. warning::
 
     **Requirement:** The `APCu extension`_ must be installed and active to use
     this adapter.
@@ -30,7 +30,7 @@ and cache items version string as constructor arguments::
         $version = null
     );
 
-.. caution::
+.. warning::
 
     Use of this adapter is discouraged in write/delete heavy workloads, as these
     operations cause memory fragmentation that results in significantly degraded performance.

components/cache/adapters/couchbasebucket_adapter.rst

@@ -14,7 +14,7 @@ shared memory; you can store contents independent of your PHP environment.
 The ability to utilize a cluster of servers to provide redundancy and/or fail-over
 is also available.
 
-.. caution::
+.. warning::
 
     **Requirements:** The `Couchbase PHP extension`_ as well as a `Couchbase server`_
     must be installed, active, and running to use this adapter. Version ``2.6`` or

components/cache/adapters/couchbasecollection_adapter.rst

@@ -8,7 +8,7 @@ shared memory; you can store contents independent of your PHP environment.
 The ability to utilize a cluster of servers to provide redundancy and/or fail-over
 is also available.
 
-.. caution::
+.. warning::
 
     **Requirements:** The `Couchbase PHP extension`_ as well as a `Couchbase server`_
     must be installed, active, and running to use this adapter. Version ``3.0`` or

components/cache/adapters/filesystem_adapter.rst

@@ -33,7 +33,7 @@ and cache root path as constructor parameters::
         $directory = null
     );
 
-.. caution::
+.. warning::
 
     The overhead of filesystem IO often makes this adapter one of the *slower*
     choices. If throughput is paramount, the in-memory adapters

components/cache/adapters/memcached_adapter.rst

@@ -8,7 +8,7 @@ shared memory; you can store contents independent of your PHP environment.
 The ability to utilize a cluster of servers to provide redundancy and/or fail-over
 is also available.
 
-.. caution::
+.. warning::
 
     **Requirements:** The `Memcached PHP extension`_ as well as a `Memcached server`_
     must be installed, active, and running to use this adapter. Version ``2.2`` or
@@ -256,7 +256,7 @@ Available Options
     executed in a "fire-and-forget" manner; no attempt to ensure the operation
     has been received or acted on will be made once the client has executed it.
 
-    .. caution::
+    .. warning::
 
         Not all library operations are tested in this mode. Mixed TCP and UDP
         servers are not allowed.

components/cache/adapters/php_files_adapter.rst

@@ -28,7 +28,7 @@ file similar to the following::
     handles file includes, this adapter has the potential to be much faster than other
     filesystem-based caches.
 
-.. caution::
+.. warning::
 
     While it supports updates and because it is using OPcache as a backend, this adapter is
     better suited for append-mostly needs. Using it in other scenarios might lead to

components/cache/adapters/redis_adapter.rst

@@ -15,7 +15,7 @@ Unlike the :doc:`APCu adapter </components/cache/adapters/apcu_adapter>`, and si
 shared memory; you can store contents independent of your PHP environment. The ability
 to utilize a cluster of servers to provide redundancy and/or fail-over is also available.
 
-.. caution::
+.. warning::
 
     **Requirements:** At least one `Redis server`_ must be installed and running to use this
     adapter. Additionally, this adapter requires a compatible extension or library that implements

components/clock.rst

@@ -129,18 +129,18 @@ is expired or not, by modifying the clock's time::
             $validUntil = new DateTimeImmutable('2022-11-16 15:25:00');
 
             // $validUntil is in the future, so it is not expired
-            static::assertFalse($expirationChecker->isExpired($validUntil));
+            $this->assertFalse($expirationChecker->isExpired($validUntil));
 
             // Clock sleeps for 10 minutes, so now is '2022-11-16 15:30:00'
             $clock->sleep(600); // Instantly changes time as if we waited for 10 minutes (600 seconds)
 
             // modify the clock, accepts all formats supported by DateTimeImmutable::modify()
-            static::assertTrue($expirationChecker->isExpired($validUntil));
+            $this->assertTrue($expirationChecker->isExpired($validUntil));
 
             $clock->modify('2022-11-16 15:00:00');
 
             // $validUntil is in the future again, so it is no longer expired
-            static::assertFalse($expirationChecker->isExpired($validUntil));
+            $this->assertFalse($expirationChecker->isExpired($validUntil));
         }
     }
 

components/config/definition.rst

@@ -685,7 +685,7 @@ The separator used in keys is typically ``_`` in YAML and ``-`` in XML.
 For example, ``auto_connect`` in YAML and ``auto-connect`` in XML. The
 normalization would make both of these ``auto_connect``.
 
-.. caution::
+.. warning::
 
     The target key will not be altered if it's mixed like
     ``foo-bar_moo`` or if it already exists.
@@ -904,7 +904,7 @@ Otherwise the result is a clean array of configuration values::
         $configs
     );
 
-.. caution::
+.. warning::
 
     When processing the configuration tree, the processor assumes that the top
     level array key (which matches the extension name) is already stripped off.

components/console/changing_default_command.rst

@@ -52,7 +52,7 @@ This will print the following to the command line:
 
     Hello World
 
-.. caution::
+.. warning::
 
     This feature has a limitation: you cannot pass any argument or option to
     the default command because they are ignored.

components/console/events.rst

@@ -14,7 +14,7 @@ the wheel, it uses the Symfony EventDispatcher component to do the work::
     $application->setDispatcher($dispatcher);
     $application->run();
 
-.. caution::
+.. warning::
 
     Console events are only triggered by the main command being executed.
     Commands called by the main command will not trigger any event, unless

components/console/helpers/formatterhelper.rst

@@ -129,10 +129,16 @@ Sometimes you want to format seconds to time. This is possible with the
 The first argument is the seconds to format and the second argument is the
 precision (default ``1``) of the result::
 
-    Helper::formatTime(42);        // 42 secs
-    Helper::formatTime(125);       // 2 mins
-    Helper::formatTime(125, 2);    // 2 mins, 5 secs
-    Helper::formatTime(172799, 4); // 1 day, 23 hrs, 59 mins, 59 secs
+    Helper::formatTime(0.001);         // 1 ms
+    Helper::formatTime(42);            // 42 s
+    Helper::formatTime(125);           // 2 min
+    Helper::formatTime(125, 2);        // 2 min, 5 s
+    Helper::formatTime(172799, 4);     // 1 d, 23 h, 59 min, 59 s
+    Helper::formatTime(172799.056, 5); // 1 d, 23 h, 59 min, 59 s, 56 ms
+
+.. versionadded:: 7.3
+
+    Support for formatting up to milliseconds was introduced in Symfony 7.3.
 
 Formatting Memory
 -----------------

components/console/helpers/progressbar.rst

@@ -323,7 +323,7 @@ to display it can be customized::
     // the bar width
     $progressBar->setBarWidth(50);
 
-.. caution::
+.. warning::
 
     For performance reasons, Symfony redraws the screen once every 100ms. If this is too
     fast or too slow for your application, use the methods

components/console/helpers/questionhelper.rst

@@ -329,7 +329,7 @@ convenient for passwords::
         return Command::SUCCESS;
     }
 
-.. caution::
+.. warning::
 
     When you ask for a hidden response, Symfony will use either a binary, change
     ``stty`` mode or use another trick to hide the response. If none is available,
@@ -392,7 +392,7 @@ method::
         return Command::SUCCESS;
     }
 
-.. caution::
+.. warning::
 
     The normalizer is called first and the returned value is used as the input
     of the validator. If the answer is invalid, don't throw exceptions in the
@@ -540,7 +540,7 @@ This way you can test any user interaction (even complex ones) by passing the ap
     simulates a user hitting ``ENTER`` after each input, no need for passing
     an additional input.
 
-.. caution::
+.. warning::
 
     On Windows systems Symfony uses a special binary to implement hidden
     questions. This means that those questions don't use the default ``Input``

components/event_dispatcher.rst

@@ -476,11 +476,7 @@ with some other dispatchers:
 Learn More
 ----------
 
-.. toctree::
-    :maxdepth: 1
-
-    /components/event_dispatcher/generic_event
-
+* :doc:`/components/event_dispatcher/generic_event`
 * :ref:`The kernel.event_listener tag <dic-tags-kernel-event-listener>`
 * :ref:`The kernel.event_subscriber tag <dic-tags-kernel-event-subscriber>`
 

components/expression_language.rst

@@ -106,6 +106,10 @@ if the expression is not valid::
 
     $expressionLanguage->lint('1 + 2', []); // doesn't throw anything
 
+    $expressionLanguage->lint('1 + a', []);
+    // throws a SyntaxError exception:
+    // "Variable "a" is not valid around position 5 for expression `1 + a`."
+
 The behavior of these methods can be configured with some flags defined in the
 :class:`Symfony\\Component\\ExpressionLanguage\\Parser` class:
 
@@ -121,8 +125,8 @@ This is how you can use these flags::
 
     $expressionLanguage = new ExpressionLanguage();
 
-    // this returns true because the unknown variables and functions are ignored
-    var_dump($expressionLanguage->lint('unknown_var + unknown_function()', Parser::IGNORE_UNKNOWN_VARIABLES | Parser::IGNORE_UNKNOWN_FUNCTIONS));
+    // does not throw a SyntaxError because the unknown variables and functions are ignored
+    $expressionLanguage->lint('unknown_var + unknown_function()', [], Parser::IGNORE_UNKNOWN_VARIABLES | Parser::IGNORE_UNKNOWN_FUNCTIONS);
 
 .. versionadded:: 7.1
 

components/finder.rst

@@ -41,7 +41,7 @@ The ``$file`` variable is an instance of
 :class:`Symfony\\Component\\Finder\\SplFileInfo` which extends PHP's own
 :phpclass:`SplFileInfo` to provide methods to work with relative paths.
 
-.. caution::
+.. warning::
 
     The ``Finder`` object doesn't reset its internal state automatically.
     This means that you need to create a new instance if you do not want

components/form.rst

@@ -644,7 +644,7 @@ method:
 
         // ...
 
-.. caution::
+.. warning::
 
     The form's ``createView()`` method should be called *after* ``handleRequest()`` is
     called. Otherwise, when using :doc:`form events </form/events>`, changes done

components/http_foundation.rst

@@ -367,11 +367,13 @@ of the ``anonymize()`` method to specify the number of bytes that should be
 anonymized depending on the IP address format::
 
     $ipv4 = '123.234.235.236';
-    $anonymousIpv4 = IpUtils::anonymize($ipv4, v4Bytes: 3);
+    $anonymousIpv4 = IpUtils::anonymize($ipv4, 3);
     // $anonymousIpv4 = '123.0.0.0'
 
     $ipv6 = '2a01:198:603:10:396e:4789:8e99:890f';
-    $anonymousIpv6 = IpUtils::anonymize($ipv6, v6Bytes: 10);
+    // (you must define the second argument (bytes to anonymize in IPv4 addresses)
+    // even when you are only anonymizing IPv6 addresses)
+    $anonymousIpv6 = IpUtils::anonymize($ipv6, 3, 10);
     // $anonymousIpv6 = '2a01:198:603::'
 
 .. versionadded:: 7.2

components/http_kernel.rst

@@ -471,7 +471,7 @@ you will trigger the ``kernel.terminate`` event where you can perform certain
 actions that you may have delayed in order to return the response as quickly
 as possible to the client (e.g. sending emails).
 
-.. caution::
+.. warning::
 
     Internally, the HttpKernel makes use of the :phpfunction:`fastcgi_finish_request`
     PHP function. This means that at the moment, only the `PHP FPM`_ server

components/ldap.rst

@@ -70,7 +70,7 @@ distinguished name (DN) and the password of a user::
 
     $ldap->bind($dn, $password);
 
-.. caution::
+.. danger::
 
     When the LDAP server allows unauthenticated binds, a blank password will always be valid.