Fix deprecations, update to PHP 8.1 and supported deprecations versions

Author: tobias-93

AdmingeneratorFormExtensionsBundle.php

@@ -13,7 +13,7 @@
  */
 class AdmingeneratorFormExtensionsBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

DependencyInjection/AdmingeneratorFormExtensionsExtension.php

@@ -30,7 +30,7 @@ class AdmingeneratorFormExtensionsExtension extends Extension
     /**
      * {@inheritDoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
@@ -58,11 +58,9 @@ public function load(array $configs, ContainerBuilder $container)
 
     /**
      * Register the form extensions if required
-     *
-     * @param array            $config
-     * @param ContainerBuilder $container
      */
-    private function configureFormExtensions(array $config, ContainerBuilder $container) {
+    private function configureFormExtensions(array $config, ContainerBuilder $container): void
+    {
         if ($config['autocomplete']) {
             $this->registerExtension($container, 'form.type_extension.autocomplete', AutocompleteExtension::class);
         }
@@ -82,12 +80,8 @@ private function configureFormExtensions(array $config, ContainerBuilder $contai
 
     /**
      * Add the collection upload listener if required
-     *
-     * @param array $config
-     * @param ContainerBuilder $container
-     * @throws \LogicException
      */
-    private function loadUploadCollectionListener(array $config, ContainerBuilder $container)
+    private function loadUploadCollectionListener(array $config, ContainerBuilder $container): void
     {
         if ($config['async_listener_enabled']) {
             if (!(array_key_exists('async_route_name', $config) && $routeName = $config['async_route_name'])) {
@@ -107,12 +101,6 @@ private function loadUploadCollectionListener(array $config, ContainerBuilder $c
         }
     }
 
-    /**
-     * @param ContainerBuilder $container
-     * @param string           $serviceId
-     * @param string           $extensionClass
-     * @param string           $extendedTypeClass
-     */
     private function registerExtension(ContainerBuilder $container, string $serviceId, string $extensionClass, string $extendedTypeClass = FormType::class): void
     {
         $extensionDefinition = new Definition($extensionClass);
@@ -122,7 +110,8 @@ private function registerExtension(ContainerBuilder $container, string $serviceI
         $container->setDefinition($serviceId, $extensionDefinition);
     }
 
-    private function configureAssetsExtension(ContainerBuilder $container, string $uploadManager, string $imageManipulator) {
+    private function configureAssetsExtension(ContainerBuilder $container, string $uploadManager, string $imageManipulator): void
+    {
         $uploaderHelperDefinition = null;
         $imageExtensionDefinition = null;
         if ('vich_uploader' === $uploadManager) {
@@ -149,8 +138,9 @@ private function configureAssetsExtension(ContainerBuilder $container, string $u
         $container->setDefinition('admingenerator.twig.extension.image_assets', $assetsExtensionDefinition);
     }
 
-    private function loadGlobalsExtension(ContainerBuilder $container) {
-        $globalsExtensionDefinition = Environment::MAJOR_VERSION > 2 ? new Definition(IncludeGlobalsExtension::class) : new Definition(LegacyIncludeGlobalsExtension::class);
+    private function loadGlobalsExtension(ContainerBuilder $container): void
+    {
+        $globalsExtensionDefinition = new Definition(IncludeGlobalsExtension::class);
         $globalsExtensionDefinition->setArgument('$container', new Reference('service_container'));
         $globalsExtensionDefinition->addTag('twig.extension');
         $container->setDefinition('admingenerator.twig.extension.include_globals', $globalsExtensionDefinition);

DependencyInjection/Compiler/FormCompilerPass.php

@@ -13,10 +13,7 @@
  */
 class FormCompilerPass implements CompilerPassInterface
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         // Used templates
         $templates = ['@AdmingeneratorFormExtensions/Form/form_html.html.twig',

DependencyInjection/Configuration.php

@@ -12,17 +12,11 @@
  */
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * {@inheritDoc}
-     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('admingenerator_form_extensions');
-        $rootNode = method_exists(TreeBuilder::class, 'getRootNode')
-            ? $treeBuilder->getRootNode()
-            : $treeBuilder->root('admingenerator_form_extensions');
 
-        $rootNode
+        $treeBuilder->getRootNode()
             ->children()
                 ->scalarNode('upload_manager')->defaultNull()->end()
                 ->scalarNode('image_manipulator')->defaultNull()->end()

EventListener/UploadCollectionListener.php

@@ -3,6 +3,7 @@
 
 use Admingenerator\FormExtensionsBundle\Storage\FileStorageInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -11,47 +12,20 @@
 
 class UploadCollectionListener implements EventSubscriberInterface
 {
-    /**
-     * (non-PHPdoc)
-     * @see \Symfony\Component\EventDispatcher\EventSubscriberInterface::getSubscribedEvents()
-     */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
-        return array(KernelEvents::REQUEST => 'onRequestHandler');
+        return [KernelEvents::REQUEST => 'onRequestHandler'];
     }
 
-    /**
-     * @var FileStorageInterface
-     */
-    protected $storage;
-
-    /**
-     * @var string
-     */
-    protected $routeName;
-
-    /**
-     * @var PropertyAccessorInterface
-     */
-    protected $propertyAccessor;
-
-    /**
-     * @param FileStorageInterface      $storage
-     * @param string                    $routeName
-     * @param PropertyAccessorInterface $propertyAccessor
-     */
-    public function __construct(FileStorageInterface $storage, $routeName, PropertyAccessorInterface $propertyAccessor)
+    public function __construct(
+        protected readonly FileStorageInterface $storage,
+        protected readonly string $routeName,
+        protected readonly PropertyAccessorInterface $propertyAccessor
+    )
     {
-        $this->storage = $storage;
-        $this->routeName = $routeName;
-        $this->propertyAccessor = $propertyAccessor;
     }
 
-    /**
-     * @param GetResponseEvent $event
-     * @return GetResponseEvent
-     */
-    public function onRequestHandler(GetResponseEvent $event)
+    public function onRequestHandler(RequestEvent $event): RequestEvent
     {
         $request = $event->getRequest();
 
@@ -73,11 +47,7 @@ public function onRequestHandler(GetResponseEvent $event)
         return $event;
     }
 
-    /**
-     * @param string $propertyPath
-     * @return string
-     */
-    private function fixPropertyPath($propertyPath)
+    private function fixPropertyPath(string $propertyPath): string
     {
         if ($propertyPath[0] != '[') {
             $propertyPath = '[' . substr_replace($propertyPath, ']', strpos($propertyPath, '[')?:strlen($propertyPath), 0);
@@ -86,15 +56,11 @@ private function fixPropertyPath($propertyPath)
         return str_replace('[]', '', $propertyPath);
     }
 
-    /**
-     * @param array $files
-     * @return \stdClass
-     */
-    private function formatResponse(array $files)
+    private function formatResponse(array $files): \stdClass
     {
-        $formatedResponse = new \stdClass();
-        $formatedResponse->files = $files;
+        $formattedResponse = new \stdClass();
+        $formattedResponse->files = $files;
 
-        return $formatedResponse;
+        return $formattedResponse;
     }
 }

Form/DataTransformer/ArrayToStringTransformer.php

@@ -13,64 +13,45 @@
  */
 class ArrayToStringTransformer implements DataTransformerInterface
 {
-    /**
-     * @var string
-     */
-    private $separator;
-
-    /**
-     * @var array
-     */
-    private $keys;
-
-    /**
-     * Default constructor
-     *
-     * @param string $separator
-     * @param array $keys
-     */
-    public function __construct($separator = ',', array $keys = array())
+    public function __construct(
+        private readonly string $separator = ',',
+        private readonly array $keys = []
+    )
     {
-        $this->separator = $separator;
-        $this->keys = $keys;
     }
 
     /**
      * Transforms an array to a string
-     *
-     * {@inheritdoc}
      */
-    public function transform($array)
+    public function transform(mixed $value): string
     {
-        if (null === $array) {
+        if (null === $value) {
             return '';
         }
 
-        if (!is_array($array)) {
+        if (!is_array($value)) {
             throw new TransformationFailedException('Expected an array');
         }
 
-        $array = array_filter(array_values($array), 'strlen');
+        $value = array_filter(array_values($value), 'strlen');
 
-        return empty($array) ? '' : implode($this->separator, $array);
+        return empty($value) ? '' : implode($this->separator, $value);
     }
 
     /**
      * Transforms a string to an array
-     *
-     * {@inheritdoc}
      */
-    public function reverseTransform($string)
+    public function reverseTransform(mixed $value): array
     {
-        if (!is_string($string)) {
+        if (!is_string($value)) {
             throw new TransformationFailedException('Expected a string');
         }
 
-        if ( 0 === strlen($string)) {
-            return array();
+        if ( 0 === strlen($value)) {
+            return [];
         }
 
-        $transformedString = explode($this->separator, $string);
+        $transformedString = explode($this->separator, $value);
 
         if (!empty($this->keys)) {
             if (count($this->keys) != count($transformedString)) {

Form/EventListener/ReorderCollectionSubscriber.php

@@ -11,17 +11,14 @@
  */
 class ReorderCollectionSubscriber implements EventSubscriberInterface
 {
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
-        return array(
-            FormEvents::PRE_SUBMIT => array('preSubmit', 140),
-        );
+        return [
+            FormEvents::PRE_SUBMIT => ['preSubmit', 140],
+        ];
     }
 
-    /**
-     * @param FormEvent $event
-     */
-    public function preSubmit(FormEvent $event)
+    public function preSubmit(FormEvent $event): void
     {
         $data = $event->getData();