feat: symfony6

.github/workflows/main.yml

@@ -1,12 +1,12 @@
 name: Tests
 
-on: [ pull_request ]
+on: ["push", "pull_request"]
 
 jobs:
     static-code-analysis:
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v1
+            -   uses: actions/checkout@v3
             -   name: Run PHPStan
                 uses: docker://jakzal/phpqa
                 with:
@@ -15,11 +15,11 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php: [ '7.2', '7.4', '8.0' ]
-                symfony: [ '4.4.*', '5.3.*' ]
+                php: [ '8.0', '8.1' ]
+                symfony: [ '5.4.*', '6.0.*' ]
         name: Test on Symfony ${{ matrix.symfony }} with PHP ${{ matrix.php }}
         steps:
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
             -   uses: shivammathur/setup-php@v2
                 with:
                     php-version: ${{ matrix.php }}
@@ -28,15 +28,34 @@ jobs:
             -   run: composer require symfony/form:${{ matrix.symfony }} --no-update
             -   run: composer install
             -   run: make test
+
+    test-highest:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                php: [ '8.2' ]
+                symfony: [ '6.2.*' ]
+        name: Test on Symfony ${{ matrix.symfony }} with PHP ${{ matrix.php }}
+        steps:
+            -   uses: actions/checkout@v3
+            -   uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php }}
+                    coverage: none # disable xdebug, pcov
+            -   run: composer require symfony/framework-bundle:${{ matrix.symfony }} --no-update
+            -   run: composer require symfony/form:${{ matrix.symfony }} --no-update
+            -   run: composer install
+            -   run: make test
+
     test-lowest:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php: [ '7.2', '7.3' ]
-                symfony: [ '3.4.*', '4.4.*' ]
+                php: [ '8.0' ]
+                symfony: [ '5.4.*']
         name: Test lowest on Symfony ${{ matrix.symfony }} with PHP ${{ matrix.php }}
         steps:
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
             -   uses: shivammathur/setup-php@v2
                 with:
                     php-version: ${{ matrix.php }}
@@ -45,11 +64,15 @@ jobs:
             -   run: composer require symfony/form:${{ matrix.symfony }} --no-update
             -   run: composer install
             -   run: make test-lowest
+
     php-cs-fixer:
+        # https://github.com/jakzal/phpqa php-cs-fixer is not supported for php 8.2 (checked on 07-02-2023)
+        # https://github.com/jakzal/phpqa/issues/398
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v1
+            -   uses: actions/checkout@v3
             -   name: Run PHP-CS-Fixer
-                uses: docker://jakzal/phpqa
+                #uses: docker://jakzal/phpqa
+                uses: docker://jakzal/phpqa:php8.1-alpine
                 with:
                     args: php-cs-fixer fix --dry-run

.gitignore

@@ -1,5 +1,5 @@
 vendor/
 composer.lock
 phpunit.xml
-.php_cs.cache
+.php-cs-fixer.cache
 .phpunit.result.cache

.php_cs → .php-cs-fixer.php

@@ -1,11 +1,11 @@
 <?php
 
-return PhpCsFixer\Config::create()
-    ->setRules(array(
+return (new PhpCsFixer\Config())
+    ->setRules([
         '@Symfony' => true,
         '@Symfony:risky' => true,
         'no_superfluous_phpdoc_tags' => true,
-    ))
+    ])
     ->setRiskyAllowed(true)
     ->setFinder(
         PhpCsFixer\Finder::create()

Controller/SettingsController.php

@@ -13,51 +13,21 @@
 
 class SettingsController extends AbstractController
 {
-    /**
-     * @var string|null
-     */
-    private $securityRole;
-
-    /**
-     * @var bool
-     */
-    private $securityManageOwnSettings;
-
-    /**
-     * @var TranslatorInterface
-     */
-    private $translator;
-
-    /**
-     * @var SettingsManagerInterface
-     */
-    private $settingsManager;
-
-    /**
-     * @var string
-     */
-    private $template;
-
     public function __construct(
-        TranslatorInterface $translator,
-        SettingsManagerInterface $settingsManager,
-        string $template,
-        bool $securityManageOwnSettings,
-        ?string $securityRole
+        private TranslatorInterface $translator,
+        private SettingsManagerInterface $settingsManager,
+        private string $template,
+        private bool $securityManageOwnSettings,
+        private ?string $securityRole,
     ) {
-        $this->translator = $translator;
-        $this->settingsManager = $settingsManager;
-        $this->template = $template;
-        $this->securityManageOwnSettings = $securityManageOwnSettings;
-        $this->securityRole = $securityRole;
     }
 
     /**
      * @throws AccessDeniedException
      */
     public function manageGlobalAction(Request $request): Response
     {
-        if (null !== $this->securityRole && !$this->get('security.authorization_checker')->isGranted($this->securityRole)) {
+        if (null !== $this->securityRole && !$this->isGranted($this->securityRole)) {
             throw new AccessDeniedException($this->translator->trans('not_allowed_to_edit_global_settings', [], 'settings'));
         }
 
@@ -69,17 +39,18 @@ public function manageGlobalAction(Request $request): Response
      */
     public function manageOwnAction(Request $request): Response
     {
-        if (null === $this->get('security.token_storage')->getToken()) {
+        $user = $this->getUser();
+
+        if (null === $user) {
             throw new AccessDeniedException($this->translator->trans('must_be_logged_in_to_edit_own_settings', [], 'settings'));
         }
 
         if (!$this->securityManageOwnSettings) {
             throw new AccessDeniedException($this->translator->trans('not_allowed_to_edit_own_settings', [], 'settings'));
         }
 
-        $user = $this->get('security.token_storage')->getToken()->getUser();
         if (!$user instanceof SettingsOwnerInterface) {
-            //For this to work the User entity must implement SettingsOwnerInterface
+            // For this to work the User entity must implement SettingsOwnerInterface
             throw new AccessDeniedException();
         }
 

DependencyInjection/Configuration.php

@@ -13,15 +13,10 @@ class Configuration implements ConfigurationInterface
     /**
      * {@inheritdoc}
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('dmishh_settings');
-        // Keep compatibility with symfony/config < 4.2
-        if (!method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->root('dmishh_settings');
-        } else {
-            $rootNode = $treeBuilder->getRootNode();
-        }
+        $rootNode = $treeBuilder->getRootNode();
 
         $scopes = [
             SettingsManagerInterface::SCOPE_ALL,
@@ -32,7 +27,7 @@ public function getConfigTreeBuilder()
         $rootNode
             ->children()
                 ->scalarNode('template')
-                    ->defaultValue('DmishhSettingsBundle:Settings:manage.html.twig')
+                    ->defaultValue('@DmishhSettings/Settings/manage.html.twig')
                 ->end()
                 ->scalarNode('cache_service')->defaultNull()->info('A service implementing Psr\Cache\CacheItemPoolInterface')->end()
                 ->integerNode('cache_lifetime')->defaultValue(3600)->end()
@@ -74,7 +69,7 @@ public function getConfigTreeBuilder()
                                 ->end()
                             ->end()
                             ->variableNode('constraints')
-                                ->info('The constraints on this option. Example, use constraits found in Symfony\Component\Validator\Constraints')
+                                ->info('The constraints on this option. Example, use constraints found in Symfony\Component\Validator\Constraints')
                                 ->defaultValue([])
                                 ->validate()
                                     ->always(function ($v) {

DependencyInjection/DmishhSettingsExtension.php

@@ -22,8 +22,10 @@ class DmishhSettingsExtension extends Extension
 {
     /**
      * {@inheritdoc}
+     *
+     * @param array<array<mixed>> $configs
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);

Entity/Setting.php

@@ -4,48 +4,31 @@
 
 use Doctrine\ORM\Mapping as ORM;
 
-/**
- * @ORM\Table(name="dmishh_settings", indexes={@ORM\Index(name="name_owner_id_idx", columns={"name", "owner_id"})})
- * @ORM\Entity
- */
+#[ORM\Table(name: 'dmishh_settings')]
+#[ORM\Index(name: 'name_owner_id_idx', columns: ['name', 'owner_id'])]
+#[ORM\Entity]
 class Setting
 {
-    /**
-     * @var int
-     *
-     * @ORM\Column(type="integer")
-     * @ORM\Id
-     * @ORM\GeneratedValue(strategy="AUTO")
-     */
-    private $id;
+    #[ORM\Column(type: 'integer')]
+    #[ORM\Id]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    private ?int $id;
 
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(type="string", length=255)
-     */
-    private $name;
+    #[ORM\Column(type: 'string', length: 255)]
+    private ?string $name;
 
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(type="text", nullable=true)
-     */
-    private $value;
+    #[ORM\Column(type: 'text', nullable: true)]
+    private ?string $value;
 
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(name="owner_id", type="string", length=255, nullable=true)
-     */
-    private $ownerId;
+    #[ORM\Column(name: 'owner_id', type: 'string', length: 255, nullable: true)]
+    private ?string $ownerId;
 
     public function getId(): ?int
     {
         return $this->id;
     }
 
-    public function setName(?string $name)
+    public function setName(?string $name): void
     {
         $this->name = $name;
     }
@@ -70,7 +53,7 @@ public function getOwnerId(): ?string
         return $this->ownerId;
     }
 
-    public function setOwnerId(?string $ownerId)
+    public function setOwnerId(?string $ownerId): void
     {
         $this->ownerId = $ownerId;
     }

Exception/InvalidArgumentException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Dmishh\SettingsBundle\Exception;
+
+class InvalidArgumentException extends \InvalidArgumentException implements SettingsException
+{
+}

Exception/UnknownConstraintException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Dmishh\SettingsBundle\Exception;
+
+class UnknownConstraintException extends \RuntimeException implements SettingsException
+{
+    public function __construct(string $className)
+    {
+        parent::__construct(sprintf('Constraint class "%s" not found', $className));
+    }
+}

Exception/UnknownSerializerException.php

@@ -4,7 +4,7 @@
 
 class UnknownSerializerException extends \RuntimeException implements SettingsException
 {
-    public function __construct($serializerClass)
+    public function __construct(string $serializerClass)
     {
         parent::__construct(sprintf('Unknown serializer class "%s"', $serializerClass));
     }

Exception/UnknownSettingException.php

@@ -4,7 +4,7 @@
 
 class UnknownSettingException extends \RuntimeException implements SettingsException
 {
-    public function __construct($settingName)
+    public function __construct(string $settingName)
     {
         parent::__construct(sprintf('Unknown setting "%s"', $settingName));
     }

Exception/WrongScopeException.php

@@ -6,7 +6,7 @@
 
 class WrongScopeException extends \LogicException implements SettingsException
 {
-    public function __construct($scope, $settingName)
+    public function __construct(string $scope, string $settingName)
     {
         if (SettingsManagerInterface::SCOPE_GLOBAL === $scope) {
             $message = sprintf(