minor #1291 Add various comments in the codebase (Antoine Makdessi, 94noni)

This PR was merged into the main branch.

Discussion
----------

Add various comments in the codebase

Add some comments while reading some source code
Ref https://symfony.com/doc/current/setup.html#the-symfony-demo-application

Commits
-------

f632ba7 Composer v2.2
1f1e6b9 Add various comments in the codebase

Author: javiereguiluz

composer.json

@@ -65,7 +65,12 @@
         "preferred-install": {
             "*": "dist"
         },
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true,
+            "symfony/flex": true,
+            "symfony/runtime": true
+        }
     },
     "autoload": {
         "psr-4": {

src/Controller/Admin/BlogController.php

@@ -30,7 +30,7 @@
  * purposes. However, in your real Symfony application you should use any of the
  * existing bundles that let you generate ready-to-use backends without effort.
  *
- * See http://knpbundles.com/keyword/admin
+ * See https://symfony.com/bundles/EasyAdminBundle/current/index.html
  *
  * @author Ryan Weaver <[email protected]>
  * @author Javier Eguiluz <[email protected]>

src/Controller/BlogController.php

@@ -81,6 +81,13 @@ public function postShow(Post $post): Response
         // have enabled the DebugBundle. Uncomment the following line to see it in action:
         //
         // dump($post, $this->getUser(), new \DateTime());
+        //
+        // The result will be displayed either in the Symfony Profiler or in the stream output.
+        // See https://symfony.com/doc/current/profiler.html
+        // See https://symfony.com/doc/current/templates.html#the-dump-twig-utilities
+        //
+        // You can also leverage Symfony's 'dd()' function that dump and
+        // stop the execution
 
         return $this->render('blog/post_show.html.twig', ['post' => $post]);
     }

src/Security/PostVoter.php

@@ -37,7 +37,7 @@ class PostVoter extends Voter
      */
     protected function supports(string $attribute, $subject): bool
     {
-        // this voter is only executed for three specific permissions on Post objects
+        // this voter is only executed on Post objects and for three specific permissions
         return $subject instanceof Post && \in_array($attribute, [self::SHOW, self::EDIT, self::DELETE], true);
     }
 

src/Utils/Validator.php

@@ -17,6 +17,7 @@
 /**
  * This class is used to provide an example of integrating simple classes as
  * services into a Symfony application.
+ * See https://symfony.com/doc/current/service_container.html#creating-configuring-services-in-the-container
  *
  * @author Javier Eguiluz <[email protected]>
  */