minor #15266 Fixed syntax errors on 4.4 (Nyholm)

javiereguiluz · javiereguiluz · commit 5398a9321c0c · 2021-04-21T09:37:27.000+02:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- Fixed syntax errors on 4.4 I ran the [new parser](#15257) on 4.4. There are about 130 more syntax errors that I decided not to fix. Some are false positives (ie a code example where we only have a PHP array). Others show some limitations of the parser. Ie, we cannot automatically detect a code block with no language, we currently assume it is PHP but that is not always correct. This is the last fixes I'll do for 4.4. Commits ------- 2a9103c Fixed syntax errors on 4.4
diff --git a/components/console/helpers/formatterhelper.rst b/components/console/helpers/formatterhelper.rst
@@ -78,7 +78,9 @@ you can write::
     $truncatedMessage = $formatter->truncate($message, 7);
     $output->writeln($truncatedMessage);
 
-And the output will be::
+And the output will be:
+
+.. code-block:: text
 
     This is...
 
@@ -93,7 +95,9 @@ from the end of the string::
 
     $truncatedMessage = $formatter->truncate($message, -5);
 
-This will result in::
+This will result in:
+
+.. code-block:: text
 
     This is a very long message, which should be trun...
 
diff --git a/components/console/helpers/table.rst b/components/console/helpers/table.rst
@@ -72,8 +72,8 @@ You can add a table separator anywhere in the output by passing an instance of
 You can optionally display titles at the top and the bottom of the table::
 
     // ...
-    $table->setHeaderTitle('Books')
-    $table->setFooterTitle('Page 1/2')
+    $table->setHeaderTitle('Books');
+    $table->setFooterTitle('Page 1/2');
     $table->render();
 
 .. code-block:: terminal
diff --git a/components/dom_crawler.rst b/components/dom_crawler.rst
@@ -555,7 +555,9 @@ You can virtually set and get values on the form::
     // where "registration" is its own array
     $values = $form->getPhpValues();
 
-To work with multi-dimensional fields::
+To work with multi-dimensional fields:
+
+.. code-block:: html
 
     <form>
         <input name="multi[]"/>
diff --git a/components/event_dispatcher.rst b/components/event_dispatcher.rst
@@ -238,7 +238,7 @@ determine which instance is passed.
         $containerBuilder->addCompilerPass(new AddEventAliasesPass([
             \AcmeFooActionEvent::class => 'acme.foo.action',
         ]));
-        $containerBuilder->addCompilerPass(new RegisterListenersPass(), PassConfig::TYPE_BEFORE_REMOVING)
+        $containerBuilder->addCompilerPass(new RegisterListenersPass(), PassConfig::TYPE_BEFORE_REMOVING);
 
         $containerBuilder->register('event_dispatcher', EventDispatcher::class);
 
diff --git a/components/filesystem.rst b/components/filesystem.rst
@@ -252,7 +252,7 @@ absolute paths and returns the relative path from the second path to the first o
         '/var/lib/symfony/src/Symfony/Component'
     );
     // returns 'videos/'
-    $filesystem->makePathRelative('/tmp/videos', '/tmp')
+    $filesystem->makePathRelative('/tmp/videos', '/tmp');
 
 ``mirror``
 ~~~~~~~~~~
diff --git a/components/http_foundation.rst b/components/http_foundation.rst
@@ -547,7 +547,7 @@ represented by a PHP callable instead of a string::
     header in the response::
 
         // disables FastCGI buffering in nginx only for this response
-        $response->headers->set('X-Accel-Buffering', 'no')
+        $response->headers->set('X-Accel-Buffering', 'no');
 
 .. _component-http-foundation-serving-files:
 
diff --git a/components/intl.rst b/components/intl.rst
@@ -11,7 +11,7 @@ The Intl Component
 .. caution::
 
     The replacement layer is limited to the ``en`` locale. If you want to use
-    other locales, you should `install the intl extension`_. There is no conflict 
+    other locales, you should `install the intl extension`_. There is no conflict
     between the two because, even if you use the extension, this package can still
     be useful to access the ICU data.
 
@@ -231,9 +231,9 @@ Locales
 ~~~~~~~
 
 A locale is the combination of a language, a region and some parameters that
-define the interface preferences of the user. For example, "Chinese" is the 
-language and ``zh_Hans_MO`` is the locale for "Chinese" (language) + "Simplified" 
-(script) + "Macau SAR China" (region). The ``Locales`` class provides access to 
+define the interface preferences of the user. For example, "Chinese" is the
+language and ``zh_Hans_MO`` is the locale for "Chinese" (language) + "Simplified"
+(script) + "Macau SAR China" (region). The ``Locales`` class provides access to
 the name of all locales::
 
     use Symfony\Component\Intl\Locales;
@@ -351,7 +351,7 @@ translate into any locale with the ``getName()`` method shown earlier::
 The reverse lookup is also possible thanks to the ``getCountryCode()`` method,
 which returns the code of the country where the given timezone ID belongs to::
 
-    $countryCode = Timezones::getCountryCode('America/Vancouver')
+    $countryCode = Timezones::getCountryCode('America/Vancouver');
     // => $countryCode = 'CA' (CA = Canada)
 
 The `UTC/GMT time offsets`_ of all timezones are provided by ``getRawOffset()``
diff --git a/components/lock.rst b/components/lock.rst
@@ -63,7 +63,7 @@ method can be safely called repeatedly, even if the lock is already acquired.
 
     Unlike other implementations, the Lock Component distinguishes lock
     instances even when they are created for the same resource. It means that for
-    a given scope and resource one lock instance can be acquired multiple times. 
+    a given scope and resource one lock instance can be acquired multiple times.
     If a lock has to be used by several services, they should share the same ``Lock``
     instance returned by the ``LockFactory::createLock`` method.
 
@@ -223,7 +223,7 @@ Lock will be released automatically as soon as one process finishes::
         sleep(30);
     } else {
         // Child process
-        echo 'The lock will be released now.'
+        echo 'The lock will be released now.';
         exit(0);
     }
     // ...
diff --git a/components/options_resolver.rst b/components/options_resolver.rst
@@ -511,7 +511,7 @@ the closure::
 
             $resolver->setDefault('host', function (Options $options, $previousValue) {
                 if ('ssl' === $options['encryption']) {
-                    return 'secure.example.org'
+                    return 'secure.example.org';
                 }
 
                 // Take default value configured in the base class
diff --git a/components/phpunit_bridge.rst b/components/phpunit_bridge.rst
@@ -629,7 +629,7 @@ constraint to test the validity of the email domain::
     {
         public function testEmail()
         {
-            $validator = ...
+            $validator = ...;
             $constraint = new Email(['checkMX' => true]);
 
             $result = $validator->validate('foo@example.com', $constraint);
@@ -654,7 +654,7 @@ the data you expect to get for the given hosts::
         {
             DnsMock::withMockedHosts(['example.com' => [['type' => 'MX']]]);
 
-            $validator = ...
+            $validator = ...;
             $constraint = new Email(['checkMX' => true]);
 
             $result = $validator->validate('foo@example.com', $constraint);
diff --git a/components/security/authorization.rst b/components/security/authorization.rst
@@ -188,7 +188,7 @@ expressions have access to a number of
 
     $expression = new Expression(
         '"ROLE_ADMIN" in roles or (not is_anonymous() and user.isSuperAdmin())'
-    )
+    );
 
     $vote = $expressionVoter->vote($token, $object, [$expression]);
 
diff --git a/components/serializer.rst b/components/serializer.rst
@@ -901,7 +901,9 @@ For example, take an object normalized as following::
 
     ['foo' => [1, 2], 'bar' => true];
 
-The ``XmlEncoder`` will encode this object like that::
+The ``XmlEncoder`` will encode this object like that:
+
+.. code-block:: xml
 
     <?xml version="1.0" encoding="UTF-8" ?>
     <response>
diff --git a/components/validator/resources.rst b/components/validator/resources.rst
@@ -155,7 +155,7 @@ implement the PSR-6 interface :class:`Psr\\Cache\\CacheItemPoolInterface`)::
 
     $validator = Validation::createValidatorBuilder()
         // ... add loaders
-        ->setMappingCache(new SomePsr6Cache());
+        ->setMappingCache(new SomePsr6Cache())
         ->getValidator();
 
 .. versionadded:: 4.4
diff --git a/components/workflow.rst b/components/workflow.rst
@@ -68,8 +68,8 @@ are trying to use it with::
     use Symfony\Component\Workflow\Registry;
     use Symfony\Component\Workflow\SupportStrategy\InstanceOfSupportStrategy;
 
-    $blogPostWorkflow = ...
-    $newsletterWorkflow = ...
+    $blogPostWorkflow = ...;
+    $newsletterWorkflow = ...;
 
     $registry = new Registry();
     $registry->addWorkflow($blogPostWorkflow, new InstanceOfSupportStrategy(BlogPost::class));
diff --git a/configuration/override_dir_structure.rst b/configuration/override_dir_structure.rst
@@ -230,7 +230,7 @@ option in your ``composer.json`` file like this:
         "config": {
             "bin-dir": "bin",
             "vendor-dir": "/some/dir/vendor"
-        },
+        }
     }
 
 .. tip::
diff --git a/configuration/using_parameters_in_dic.rst b/configuration/using_parameters_in_dic.rst
@@ -85,8 +85,8 @@ Now, examine the results to see this closely:
                 // true/false (depends on 2nd parameter of Kernel),
                 // as expected, because %kernel.debug% inside configuration
                 // gets evaluated before being passed to the extension
-            )
-        ];
+            ]
+        );
 
         $container->loadFromExtension('my_bundle');
         // passes the string "%kernel.debug%".
diff --git a/contributing/code/conventions.rst b/contributing/code/conventions.rst
@@ -188,15 +188,19 @@ after the use declarations, like in this example from
 
 .. _`ServiceRouterLoader`: https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/Routing/Loader/DependencyInjection/ServiceRouterLoader.php
 
-The deprecation must be added to the ``CHANGELOG.md`` file of the impacted component::
+The deprecation must be added to the ``CHANGELOG.md`` file of the impacted component:
+
+.. code-block:: markdown
 
     4.4
     ---
 
     * Deprecate the `Deprecated` class, use `Replacement` instead
 
 It must also be added to the ``UPGRADE.md`` file of the targeted minor version
-(``UPGRADE-4.4.md`` in our example)::
+(``UPGRADE-4.4.md`` in our example):
+
+.. code-block:: markdown
 
     DependencyInjection
     -------------------
diff --git a/controller/soap_web_service.rst b/controller/soap_web_service.rst
@@ -39,7 +39,7 @@ In this case, the SOAP service will allow the client to call a method called
         public function hello($name)
         {
 
-            $message = new \Swift_Message('Hello Service')
+            $message = (new \Swift_Message('Hello Service'))
                 ->setTo('me@example.com')
                 ->setBody($name.' says hi!');
 
diff --git a/create_framework/front_controller.rst b/create_framework/front_controller.rst
@@ -185,7 +185,9 @@ the ``setContent()`` directly from the front controller script::
 
     // ...
 
-And the ``hello.php`` script can now be converted to a template::
+And the ``hello.php`` script can now be converted to a template:
+
+.. code-block:: html+php
 
     <!-- example.com/src/pages/hello.php -->
     <?php $name = $request->get('name', 'World') ?>
diff --git a/create_framework/routing.rst b/create_framework/routing.rst
@@ -30,7 +30,9 @@ framework just a little to make templates even more readable::
     $response->send();
 
 As we now extract the request query parameters, simplify the ``hello.php``
-template as follows::
+template as follows:
+
+.. code-block:: html+php
 
     <!-- example.com/src/pages/hello.php -->
     Hello <?= htmlspecialchars(isset($name) ? $name : 'World', ENT_QUOTES, 'UTF-8') ?>
@@ -161,7 +163,9 @@ There are a few new things in the code:
 
 * ``500`` errors are now managed correctly;
 
-* Request attributes are extracted to keep our templates simple::
+* Request attributes are extracted to keep our templates simple:
+
+.. code-block:: html+php
 
     // example.com/src/pages/hello.php
     Hello <?= htmlspecialchars($name, ENT_QUOTES, 'UTF-8') ?>
diff --git a/doctrine/custom_dql_functions.rst b/doctrine/custom_dql_functions.rst
@@ -131,16 +131,14 @@ In Symfony, you can register your custom DQL functions as follows:
             use App\DQL\DatetimeFunction;
 
             $container->loadFromExtension('doctrine', [
-                'doctrine' => [
-                    'orm' => [
-                        // ...
-                        'entity_managers' => [
-                            'example_manager' => [
-                                // place your functions here
-                                'dql' => [
-                                    'datetime_functions' => [
-                                        'test_datetime' => DatetimeFunction::class,
-                                    ],
+                'orm' => [
+                    // ...
+                    'entity_managers' => [
+                        'example_manager' => [
+                            // place your functions here
+                            'dql' => [
+                                'datetime_functions' => [
+                                    'test_datetime' => DatetimeFunction::class,
                                 ],
                             ],
                         ],
diff --git a/form/create_form_type_extension.rst b/form/create_form_type_extension.rst
@@ -191,14 +191,10 @@ Specifically, you need to override the ``file_widget`` block:
     {% extends 'form_div_layout.html.twig' %}
 
     {% block file_widget %}
-        {% spaceless %}
-
         {{ block('form_widget') }}
         {% if image_url is not null %}
             <img src="{{ asset(image_url) }}"/>
         {% endif %}
-
-        {% endspaceless %}
     {% endblock %}
 
 Be sure to :ref:`configure this form theme template <forms-theming-global>` so that
diff --git a/form/data_transformers.rst b/form/data_transformers.rst
@@ -208,7 +208,7 @@ to and from the issue number and the ``Issue`` object::
         {
             // no issue number? It's optional, so that's ok
             if (!$issueNumber) {
-                return;
+                return null;
             }
 
             $issue = $this->entityManager
diff --git a/form/type_guesser.rst b/form/type_guesser.rst
@@ -101,7 +101,7 @@ With this knowledge, you can implement the ``guessType()`` method of the
             $annotations = $this->readPhpDocAnnotations($class, $property);
 
             if (!isset($annotations['var'])) {
-                return; // guess nothing if the @var annotation is not available
+                return null; // guess nothing if the @var annotation is not available
             }
 
             // otherwise, base the type on the @var annotation
diff --git a/form/validation_group_service_resolver.rst b/form/validation_group_service_resolver.rst
@@ -39,7 +39,7 @@ Then in your form, inject the resolver and set it as the ``validation_groups``::
     namespace App\Form;
 
     use App\Validator\ValidationGroupResolver;
-    use Symfony\Component\Form\AbstractType
+    use Symfony\Component\Form\AbstractType;
     use Symfony\Component\OptionsResolver\OptionsResolver;
 
     class MyClassType extends AbstractType
diff --git a/forms.rst b/forms.rst
@@ -592,7 +592,7 @@ argument of ``createForm()``::
         {
             $task = new Task();
             // use some PHP logic to decide if this form field is required or not
-            $dueDateIsRequired = ...
+            $dueDateIsRequired = ...;
 
             $form = $this->createForm(TaskType::class, $task, [
                 'require_due_date' => $dueDateIsRequired,
diff --git a/http_client.rst b/http_client.rst
@@ -885,7 +885,7 @@ To abort a request (e.g. because it didn't complete in due time, or you want to
 fetch only the first bytes of the response, etc.), you can either use the
 ``cancel()`` method of ``ResponseInterface``::
 
-    $response->cancel()
+    $response->cancel();
 
 Or throw an exception from a progress callback::
 
diff --git a/introduction/from_flat_php_to_symfony.rst b/introduction/from_flat_php_to_symfony.rst
@@ -580,7 +580,7 @@ and uses Twig:
 
 .. code-block:: html+twig
 
-    <!-- templates/blog/list.html.twig -->
+    {# templates/blog/list.html.twig #}
     {% extends 'base.html.twig' %}
 
     {% block title %}List of Posts{% endblock %}
diff --git a/mercure.rst b/mercure.rst
@@ -622,7 +622,7 @@ You can instead make use of the `MockHub`::
 
             $controller = new MessageController($hub);
 
-            ...
+            // ...
         }
     }
 
@@ -645,13 +645,14 @@ During functional testing you can instead decorate the Hub::
     }
 
 HubStub decorates the default hub service so no updates are actually
-sent. Here is the HubStub implementation::
+sent. Here is the HubStub implementation:
+
+.. code-block:: yaml
 
     # config/services_test.yaml
     App\Tests\Functional\Fixtures\HubStub:
         decorates: mercure.hub.default
 
-
 Debugging
 ---------
 
diff --git a/migration.rst b/migration.rst
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
diff --git a/reference/constraints/Traverse.rst b/reference/constraints/Traverse.rst
diff --git a/service_container.rst b/service_container.rst
diff --git a/setup/homestead.rst b/setup/homestead.rst
diff --git a/templating/PHP.rst b/templating/PHP.rst
diff --git a/templating/hinclude.rst b/templating/hinclude.rst
diff --git a/testing.rst b/testing.rst
diff --git a/translation.rst b/translation.rst

Original file line number	Diff line number	Diff line change
`@@ -511,7 +511,7 @@ the closure::`
`511`	`511`
`512`	`512`	`$resolver->setDefault('host', function (Options $options, $previousValue) {`
`513`	`513`	`if ('ssl' === $options['encryption']) {`
`514`		`- return 'secure.example.org'`
	`514`	`+ return 'secure.example.org';`
`515`	`515`	`}`
`516`	`516`
`517`	`517`	`// Take default value configured in the base class`
Original file line number	Diff line number	Diff line change
`@@ -629,7 +629,7 @@ constraint to test the validity of the email domain::`
`629`	`629`	`{`
`630`	`630`	`public function testEmail()`
`631`	`631`	`{`
`632`		`- $validator = ...`
	`632`	`+ $validator = ...;`
`633`	`633`	`$constraint = new Email(['checkMX' => true]);`
`634`	`634`
`635`	`635`	`$result = $validator->validate('[email protected]', $constraint);`
`@@ -654,7 +654,7 @@ the data you expect to get for the given hosts::`
`654`	`654`	`{`
`655`	`655`	`DnsMock::withMockedHosts(['example.com' => [['type' => 'MX']]]);`
`656`	`656`
`657`		`- $validator = ...`
	`657`	`+ $validator = ...;`
`658`	`658`	`$constraint = new Email(['checkMX' => true]);`
`659`	`659`
`660`	`660`	`$result = $validator->validate('[email protected]', $constraint);`
Original file line number	Diff line number	Diff line change
@@ -230,7 +230,7 @@ option in your ``composer.json`` file like this:
`230`	`230`	`"config": {`
`231`	`231`	`"bin-dir": "bin",`
`232`	`232`	`"vendor-dir": "/some/dir/vendor"`
`233`		`- },`
	`233`	`+ }`
`234`	`234`	`}`
`235`	`235`
`236`	`236`	`.. tip::`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ In this case, the SOAP service will allow the client to call a method called`
`39`	`39`	`public function hello($name)`
`40`	`40`	`{`
`41`	`41`
`42`		`- $message = new \Swift_Message('Hello Service')`
	`42`	`+ $message = (new \Swift_Message('Hello Service'))`
`43`	`43`	`->setTo('[email protected]')`
`44`	`44`	`->setBody($name.' says hi!');`
`45`	`45`
Original file line number	Diff line number	Diff line change
@@ -208,7 +208,7 @@ to and from the issue number and the ``Issue`` object::
`208`	`208`	`{`
`209`	`209`	`// no issue number? It's optional, so that's ok`
`210`	`210`	`if (!$issueNumber) {`
`211`		`- return;`
	`211`	`+ return null;`
`212`	`212`	`}`
`213`	`213`
`214`	`214`	`$issue = $this->entityManager`
Original file line number	Diff line number	Diff line change
@@ -101,7 +101,7 @@ With this knowledge, you can implement the ``guessType()`` method of the
`101`	`101`	`$annotations = $this->readPhpDocAnnotations($class, $property);`
`102`	`102`
`103`	`103`	`if (!isset($annotations['var'])) {`
`104`		`- return; // guess nothing if the @var annotation is not available`
	`104`	`+ return null; // guess nothing if the @var annotation is not available`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`// otherwise, base the type on the @var annotation`
Original file line number	Diff line number	Diff line change
@@ -592,7 +592,7 @@ argument of ``createForm()``::
`592`	`592`	`{`
`593`	`593`	`$task = new Task();`
`594`	`594`	`// use some PHP logic to decide if this form field is required or not`
`595`		`- $dueDateIsRequired = ...`
	`595`	`+ $dueDateIsRequired = ...;`
`596`	`596`
`597`	`597`	`$form = $this->createForm(TaskType::class, $task, [`
`598`	`598`	`'require_due_date' => $dueDateIsRequired,`
Original file line number	Diff line number	Diff line change
@@ -622,7 +622,7 @@ You can instead make use of the `MockHub`::
`622`	`622`
`623`	`623`	`$controller = new MessageController($hub);`
`624`	`624`
`625`		`- ...`
	`625`	`+ // ...`
`626`	`626`	`}`
`627`	`627`	`}`
`628`	`628`
`@@ -645,13 +645,14 @@ During functional testing you can instead decorate the Hub::`
`645`	`645`	`}`
`646`	`646`
`647`	`647`	`HubStub decorates the default hub service so no updates are actually`
`648`		`-sent. Here is the HubStub implementation::`
	`648`	`+sent. Here is the HubStub implementation:`
	`649`	`+`
	`650`	`+.. code-block:: yaml`
`649`	`651`
`650`	`652`	`# config/services_test.yaml`
`651`	`653`	`App\Tests\Functional\Fixtures\HubStub:`
`652`	`654`	`decorates: mercure.hub.default`
`653`	`655`
`654`		`-`
`655`	`656`	`Debugging`
`656`	`657`	`---------`
`657`	`658`