Сервис проверки контроллеров роутов на существование.

Author: ProklUng

DependencyInjection/Configuration.php

@@ -29,6 +29,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('router_request_context_base_url')->defaultValue('')->end()
                 ->scalarNode('router_cache_path')->defaultValue('%kernel.cache_dir%/routes')->end()
                 ->scalarNode('router_config_file')->defaultValue('app/routes.yaml')->end()
+                ->booleanNode('router_check_exists_controller')->defaultValue(false)->end()
                 ->arrayNode('controller_annotations_path')
                     ->useAttributeAsKey('name')
                     ->prototype('scalar')->end()

DependencyInjection/WpSymfonyRouterExtension.php

@@ -83,6 +83,10 @@ private function registerRouterConfiguration(
     ): void {
         $annotationsConfigEnabled = $container->getParameter('enable_annotations');
 
+        if ($config['router_check_exists_controller'] === false) {
+            $container->removeDefinition('router.checker.exists.autoload');
+        }
+
         if ($config['default_uri'] === null) {
             $host = (string)$container->getParameter('kernel.http.host');
             $schema = (string)$container->getParameter('kernel.schema');
@@ -100,7 +104,8 @@ private function registerRouterConfiguration(
                 'symfony/framework-bundle',
                 '5.2',
                 'Not setting the "framework.router.utf8" configuration option is deprecated, 
-                it will default to "true" in version 6.0.');
+                it will default to "true" in version 6.0.'
+            );
         }
 
         $container->setParameter('router.request.context.host', $config['router_request_context_host']);

Resources/config/services.yaml

@@ -94,6 +94,17 @@ services:
     class: Prokl\WpSymfonyRouterBundle\Services\Annotations\SearchAnnotatedClasses
     arguments: ['%kernel.project_dir%', '%controller.annotations.path%']
 
+  # Проверка роутов на существование контроллеров.
+  router.checker.exists:
+    class: Prokl\WpSymfonyRouterBundle\Services\Utils\RouteCheckerExist
+    arguments: ['@routes.collection']
+
+  # Проверка роутов на существование контроллеров.
+  router.checker.exists.autoload:
+    class: Prokl\WpSymfonyRouterBundle\Services\Utils\RouteCheckerExist
+    factory: ['@router.checker.exists', 'check']
+    tags: ['service.bootstrap']
+
   # Диспетчер запуска контроллеров.
   dispatcher.controller:
     class: Prokl\WpSymfonyRouterBundle\Services\Utils\DispatchController

Services/Utils/RouteCheckerExist.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Prokl\WpSymfonyRouterBundle\Services\Utils;
+
+use LogicException;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * Class RouteCheckerExist
+ * @package Prokl\WpSymfonyRouterBundle\Services\Utils
+ */
+class RouteCheckerExist
+{
+    /**
+     * @var RouteCollection $routeCollection Коллекция роутов.
+     */
+    private $routeCollection;
+
+    /**
+     * RouteCheckerExist constructor.
+     *
+     * @param RouteCollection $routeCollection Коллекция роутов.
+     */
+    public function __construct(RouteCollection $routeCollection)
+    {
+        $this->routeCollection = $routeCollection;
+    }
+
+    /**
+     * Проверка роутов на существование контроллеров.
+     *
+     * @return void
+     * @throws LogicException Когда контроллер не существует.
+     */
+    public function check() : void
+    {
+        $allRoutes = $this->routeCollection->all();
+        foreach ($allRoutes as $nameRoute => $route) {
+            $controller = $route->getDefault('_controller');
+            if (is_string($controller)) {
+                if (strpos($controller, '::') !== false) {
+                    $callback = explode('::', $controller, 2);
+                    $class = $callback[0];
+                } else {
+                    // _invoke_
+                    $class = $controller;
+                }
+
+                if (!class_exists($class)) {
+                    throw new LogicException(
+                        sprintf(
+                            'Class %s declaring as controller for route %s not exists.',
+                            $class,
+                            $nameRoute
+                        )
+                    );
+                }
+            }
+        }
+    }
+}

readme.MD

@@ -19,3 +19,4 @@
 - `controller_annotations_path` - массив с путями к контроллерам, использующим аннотации. 
 - `router_cache_path` - путь к кэшу аннотаций. По умолчанию `%kernel.cache_dir%/routes`. 
 - `router_config_file` - путь к файлу с конфигурацией роутов. По умолчанию  `app/routes.yaml`. Файл может быть в любом поддерживаемом Symfony формате - Yaml, PHP, XML и т.д. 
+- `router_check_exists_controller` - проверять на существование классы-контроллеры. По умолчанию `false`. 

ruleset.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+<ruleset name="RegioStandard">
+    <description>RegioMedia PHP Coding Standard</description>
+
+    <!-- Основа: https://www.php-fig.org/psr/psr-2/  -->
+    <rule ref="PSR2" />
+
+    <!-- Включают обязательность док-блоков для классов и функций -->
+    <rule ref="Squiz.Commenting.FunctionComment" />
+    <rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
+    <rule ref="Squiz.Commenting.ClassComment">
+        <exclude name="Squiz.Commenting.ClassComment.TagNotAllowed"/>.
+    </rule>
+    <rule ref="Squiz.Commenting.VariableComment" />
+
+    <!-- увеличивает лимит на длину строки по сравнению с PSR-2 -->
+    <rule ref="Generic.Files.LineLength">
+        <properties>
+            <property name="lineLimit" value="140"/>
+            <property name="absoluteLineLimit" value="200"/>
+        </properties>
+    </rule>
+
+    <!-- предупреждает об использовании нежелательных функций (устаревшие и отладочные) -->
+    <rule ref="Generic.PHP.ForbiddenFunctions">
+        <properties>
+            <property name="error" value="false" />
+            <property name="forbiddenFunctions" type="array"
+                      value="sizeof=>count,delete=>unset,d=>null,var_dump=>null" />
+        </properties>
+    </rule>
+
+    <!-- запрещает использование двойных кавычек там, где они не нужны -->
+    <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired" />
+</ruleset>