Drop support for PHP <8.0 and Symfony <5.4, add typing to all classes

Author: Tobias Feijten

.github/workflows/code_checks.yaml

@@ -24,38 +24,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.1', '7.2', '7.3', '7.4', '8.0']
+        php: ['8.0', '8.1']
         dependencies: [highest]
         symfony: ['*']
         include:
           # Minimum supported dependencies with the oldest supported PHP version
-          - php: '7.1'
+          - php: '8.0'
             dependencies: lowest
             symfony: '*'
 
           # Minimum supported dependencies with the latest supported PHP version
-          - php: '8.0'
+          - php: '8.1'
             dependencies: lowest
             symfony: '*'
 
-          - php: '8.0'
+          - php: '8.1'
             dependencies: highest
             symfony: '*'
 
           # Test each supported Symfony version with lowest supported PHP version
-          - php: '7.1'
-            dependencies: highest
-            symfony: '4.4.*'
 
-          - php: '7.2'
-            dependencies: highest
-            symfony: '5.4.*'
-
-          - php: '7.3'
-            dependencies: highest
-            symfony: '5.4.*'
-
-          - php: '7.4'
+          - php: '8.0'
             dependencies: highest
             symfony: '5.4.*'
 

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.0.0 - 2021-12-15
+- Migrate router implementation to TS ([#406](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/pull/406))
+- Allow Symfony 6 ([#408](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/pull/408))
+- [BC break] Drop support for PHP <8.0 and Symfony <5.4, add typing to all classes
+- Add documentation for attributes
+
 ## v2.8.0 - 2021-12-15
 - Fix expose: false behavior ([#404](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/pull/404))
 - Fix dump using domains ([#410](https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/pull/410))

Command/DumpCommand.php

@@ -28,37 +28,12 @@ class DumpCommand extends Command
 {
     protected static $defaultName = 'fos:js-routing:dump';
 
-    /**
-     * @var ExposedRoutesExtractorInterface
-     */
-    private $extractor;
-
-    /**
-     * @var SerializerInterface
-     */
-    private $serializer;
-
-    /**
-     * @var string
-     */
-    private $projectDir;
-
-    /**
-     * @var string
-     */
-    private $requestContextBaseUrl;
-
-    public function __construct(ExposedRoutesExtractorInterface $extractor, SerializerInterface $serializer, $projectDir, $requestContextBaseUrl = null)
+    public function __construct(private ExposedRoutesExtractorInterface $extractor, private SerializerInterface $serializer, private string $projectDir, private ?string $requestContextBaseUrl = null)
     {
-        $this->extractor = $extractor;
-        $this->serializer = $serializer;
-        $this->projectDir = $projectDir;
-        $this->requestContextBaseUrl = $requestContextBaseUrl;
-
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('fos:js-routing:dump')
@@ -128,11 +103,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     /**
      * Performs the routes dump.
-     *
-     * @param InputInterface  $input  The command input
-     * @param OutputInterface $output The command output
      */
-    private function doDump(InputInterface $input, OutputInterface $output)
+    private function doDump(InputInterface $input, OutputInterface $output): void
     {
         $domain = $input->getOption('domain');
 

Command/RouterDebugExposedCommand.php

@@ -31,23 +31,16 @@ class RouterDebugExposedCommand extends Command
 {
     protected static $defaultName = 'fos:js-routing:debug';
 
-    private $extractor;
-
-    private $router;
-
-    public function __construct(ExposedRoutesExtractorInterface $extractor, RouterInterface $router)
+    public function __construct(private ExposedRoutesExtractorInterface $extractor, private RouterInterface $router)
     {
-        $this->extractor = $extractor;
-        $this->router = $router;
-
         parent::__construct();
     }
 
 
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setDefinition(array(
@@ -104,7 +97,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return 0;
     }
 
-    protected function getRoutes($domain = array())
+    protected function getRoutes($domain = array()): RouteCollection
     {
         $routes = $this->extractor->getRoutes();
 

Controller/Controller.php

@@ -27,25 +27,7 @@
  */
 class Controller
 {
-    /**
-     * @var mixed
-     */
-    protected $serializer;
-
-    /**
-     * @var ExposedRoutesExtractorInterface
-     */
-    protected $exposedRoutesExtractor;
-
-    /**
-     * @var CacheControlConfig
-     */
-    protected $cacheControlConfig;
-
-    /**
-     * @var boolean
-     */
-    protected $debug;
+    protected CacheControlConfig $cacheControlConfig;
 
     /**
      * Default constructor.
@@ -55,18 +37,12 @@ class Controller
      * @param array                           $cacheControl
      * @param boolean                         $debug
      */
-    public function __construct($serializer, ExposedRoutesExtractorInterface $exposedRoutesExtractor, array $cacheControl = array(), $debug = false)
+    public function __construct(private mixed $serializer, private ExposedRoutesExtractorInterface $exposedRoutesExtractor, array $cacheControl = array(), private bool $debug = false)
     {
-        $this->serializer             = $serializer;
-        $this->exposedRoutesExtractor = $exposedRoutesExtractor;
         $this->cacheControlConfig     = new CacheControlConfig($cacheControl);
-        $this->debug                  = $debug;
     }
 
-    /**
-     * indexAction action.
-     */
-    public function indexAction(Request $request, $_format)
+    public function indexAction(Request $request, $_format): Response
     {
         $session = $request->hasSession() ? $request->getSession() : null;
 

DependencyInjection/Configuration.php

@@ -24,17 +24,13 @@ class Configuration implements ConfigurationInterface
     /**
      * Generates the configuration tree builder.
      *
-     * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
+     * @return TreeBuilder The tree builder
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $builder = new TreeBuilder('fos_js_routing');
-        if (\method_exists($builder, 'getRootNode')) {
-            $rootNode = $builder->getRootNode();
-        } else {
-            // BC layer for symfony/config 4.1 and older
-            $rootNode = $builder->root('fos_js_routing');
-        }
+
+        $rootNode = $builder->getRootNode();
 
         $rootNode
             ->children()

DependencyInjection/FOSJsRoutingExtension.php

@@ -19,17 +19,11 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
- * FOSJsRoutingExtension
- * Load configuration.
- *
  * @author      William DURAND <[email protected]>
  */
 class FOSJsRoutingExtension extends Extension
 {
-    /**
-     * Load configuration.
-     */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $processor = new Processor();
         $configuration = new Configuration();