Fix phpstan and php-cs issues (#382)

sulu · May 28, 2024 · bf13306 · bf13306
1 parent b87895c
commit bf13306
Show file tree

Hide file tree

Showing 26 changed files with 99 additions and 395 deletions.
diff --git a/.github/workflows/test-application.yaml b/.github/workflows/test-application.yaml
@@ -56,6 +56,26 @@ jobs:
                           DATABASE_CHARSET: utf8mb4
                           DATABASE_COLLATE: utf8mb4_unicode_ci
 
+                    - php-version: '8.2'
+                      database: mysql
+                      dependency-versions: 'highest'
+                      tools: 'composer:v2'
+                      env:
+                          SYMFONY_DEPRECATIONS_HELPER: weak
+                          DATABASE_URL: mysql://root:root@127.0.0.1/sulu_form_test?serverVersion=5.7
+                          DATABASE_CHARSET: utf8mb4
+                          DATABASE_COLLATE: utf8mb4_unicode_ci
+
+                    - php-version: '8.3'
+                      database: mysql
+                      dependency-versions: 'highest'
+                      tools: 'composer:v2'
+                      env:
+                          SYMFONY_DEPRECATIONS_HELPER: weak
+                          DATABASE_URL: mysql://root:root@127.0.0.1/sulu_form_test?serverVersion=5.7
+                          DATABASE_CHARSET: utf8mb4
+                          DATABASE_COLLATE: utf8mb4_unicode_ci
+
         services:
             mysql:
                 image: mysql:5.7
@@ -86,6 +106,9 @@ jobs:
                   tools: ${{ matrix.tools }}
                   coverage: none
 
+            - name: Remove not required tooling for tests
+              run: composer remove php-cs-fixer/shim --dev
+
             - name: Install composer dependencies
               uses: ramsey/composer-install@v1
               with:

diff --git a/Admin/FormAdmin.php b/Admin/FormAdmin.php
@@ -24,6 +24,9 @@
 use Sulu\Component\Security\Authorization\SecurityCheckerInterface;
 use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
 
+/**
+ * @final
+ */
 class FormAdmin extends Admin
 {
     public const SECURITY_CONTEXT = 'sulu.form.forms';
@@ -188,7 +191,7 @@ public function getSecurityContexts()
         return [
             'Sulu' => [
                 'Form' => [
-                    static::SECURITY_CONTEXT => [
+                    self::SECURITY_CONTEXT => [
                         PermissionTypes::VIEW,
                         PermissionTypes::ADD,
                         PermissionTypes::EDIT,

diff --git a/Configuration/FormConfiguration.php b/Configuration/FormConfiguration.php
@@ -69,11 +69,9 @@ public function getWebsiteMailConfiguration(): ?MailConfigurationInterface
     /**
      * Set admin mail configuration.
      *
-     * @param MailConfigurationInterface $adminMailConfiguration
-     *
      * @return $this
      */
-    public function setAdminMailConfiguration(MailConfigurationInterface $adminMailConfiguration = null)
+    public function setAdminMailConfiguration(?MailConfigurationInterface $adminMailConfiguration = null)
     {
         $this->adminMailConfiguration = $adminMailConfiguration;
 
@@ -83,11 +81,9 @@ public function setAdminMailConfiguration(MailConfigurationInterface $adminMailC
     /**
      * Set website mail configuration.
      *
-     * @param MailConfigurationInterface $websiteMailConfiguration
-     *
      * @return $this
      */
-    public function setWebsiteMailConfiguration(MailConfigurationInterface $websiteMailConfiguration = null)
+    public function setWebsiteMailConfiguration(?MailConfigurationInterface $websiteMailConfiguration = null)
     {
         $this->websiteMailConfiguration = $websiteMailConfiguration;
 

diff --git a/Configuration/FormConfigurationInterface.php b/Configuration/FormConfigurationInterface.php
@@ -29,7 +29,7 @@ public function getSave(): bool;
     /**
      * Get file fields.
      *
-     * @return mixed[]
+     * @return int[]
      */
     public function getFileFields(): array;
 

diff --git a/Controller/DynamicController.php b/Controller/DynamicController.php
@@ -22,7 +22,7 @@
 use Sulu\Bundle\FormBundle\Repository\FormRepository;
 use Sulu\Bundle\MediaBundle\Media\Exception\MediaNotFoundException;
 use Sulu\Bundle\MediaBundle\Media\Manager\MediaManagerInterface;
-use Sulu\Component\Rest\ListBuilder\ListRepresentation;
+use Sulu\Component\Rest\ListBuilder\PaginatedRepresentation;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
@@ -87,12 +87,15 @@ public function cgetAction(Request $request): Response
     {
         $locale = $this->getLocale($request);
         $filters = $this->getFilters($request);
-        $page = $request->get('page', 1);
-        $limit = $request->get('limit');
+        $page = (int) $request->query->getInt('page', 1);
+        $limit = (int) $request->query->getInt('limit');
         $offset = (int) (($page - 1) * $limit);
-        $view = $request->get('view', 'default');
-        $sortOrder = $request->get('sortOrder', 'asc');
-        $sortBy = $request->get('sortBy', 'created');
+        /** @var string $view */
+        $view = $request->query->get('view', 'default');
+        /** @var string $sortOrder */
+        $sortOrder = $request->query->get('sortOrder', 'asc');
+        /** @var string $sortBy */
+        $sortBy = $request->query->get('sortBy', 'created');
 
         $entries = $this->dynamicRepository->findByFilters(
             $filters,
@@ -111,12 +114,9 @@ public function cgetAction(Request $request): Response
             $total = \count($entries) + $offset;
         }
 
-        // create list representation
-        $representation = new ListRepresentation(
+        $representation = new PaginatedRepresentation(
             $entries,
             'dynamic_forms',
-            $request->get('_route'),
-            $request->query->all(),
             $page,
             $limit,
             $total
@@ -158,14 +158,14 @@ public function deleteAction(Request $request, int $id): Response
     protected function getFilters(Request $request): array
     {
         $filters = [
-            'type' => $request->get('type'),
-            'typeId' => $request->get('typeId'),
-            'webspaceKey' => $request->get('webspaceKey'),
-            'form' => $request->get('form'),
-            'fromDate' => $request->get('fromDate'),
-            'toDate' => $request->get('toDate'),
-            'search' => $request->get('search'),
-            'searchFields' => \array_filter(\explode(',', $request->get('fields', ''))),
+            'type' => $request->query->get('type'),
+            'typeId' => $request->query->get('typeId'),
+            'webspaceKey' => $request->query->get('webspaceKey'),
+            'form' => $request->query->get('form'),
+            'fromDate' => $request->query->get('fromDate'),
+            'toDate' => $request->query->get('toDate'),
+            'search' => $request->query->get('search'),
+            'searchFields' => \array_filter(\explode(',', $request->query->get('fields', ''))),
         ];
 
         return \array_filter($filters);
@@ -182,8 +182,8 @@ protected function loadForm(Request $request): Form
         return $this->formRepository->loadById($formId);
     }
 
-    public function getLocale(Request $request): ?string
+    public function getLocale(Request $request): string
     {
-        return $request->get('locale', $request->getLocale());
+        return $request->query->get('locale', $request->getLocale());
     }
 }
diff --git a/Controller/FormWebsiteController.php b/Controller/FormWebsiteController.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Form\FormError;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormRegistryInterface;
+use Symfony\Component\Form\FormTypeInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -224,7 +225,7 @@ protected function getErrors(): array
      *
      * @return mixed[]
      */
-    protected function getAttributes($attributes, StructureInterface $structure = null, $preview = false)
+    protected function getAttributes($attributes, ?StructureInterface $structure = null, $preview = false)
     {
         if (null === $this->attributes) { // for performance only called once
             $this->attributes = parent::getAttributes($attributes, $structure, $preview);
@@ -237,6 +238,9 @@ protected function getAttributes($attributes, StructureInterface $structure = nu
         return $this->attributes;
     }
 
+    /**
+     * @return class-string<FormTypeInterface>
+     */
     private function getTypeClass(string $key): string
     {
         return $this->getParameter('sulu_form.static_forms')[$key]['class'];

diff --git a/DependencyInjection/SuluFormExtension.php b/DependencyInjection/SuluFormExtension.php
@@ -212,6 +212,7 @@ public function load(array $configs, ContainerBuilder $container): void
             $loader->load('type_mailchimp.xml');
         }
 
+        /** @var array<string, class-string> $bundles */
         $bundles = $container->getParameter('kernel.bundles');
 
         if (\array_key_exists('SuluArticleBundle', $bundles)) {

diff --git a/Dynamic/FormFieldTypeConfiguration.php b/Dynamic/FormFieldTypeConfiguration.php
@@ -60,8 +60,6 @@ public function getXmlPath(): string
 
     /**
      * Sets template.
-     *
-     * @return FormFieldTypeConfiguration
      */
     public function setXmlPath(string $xmlPath): self
     {

diff --git a/Dynamic/Types/ChoiceTrait.php b/Dynamic/Types/ChoiceTrait.php
@@ -31,15 +31,18 @@ protected function getChoices(FormFieldTranslation $translation): array
     /**
      * Returns options for multichoice form type like select, multiple select, radio or checkboxes.
      *
-     * @param mixed[] $options
+     * @param array<string, mixed> $options
      *
      * @return mixed[]
      */
     private function getChoiceOptions(
         FormFieldTranslation $translation,
         array $options
     ): array {
-        if (isset($options['attr']['placeholder'])) {
+        if (isset($options['attr'])
+            && \is_array($options['attr'])
+            && isset($options['attr']['placeholder'])
+        ) {
             $options['placeholder'] = $options['attr']['placeholder'];
             unset($options['attr']['placeholder']);
         }

diff --git a/Dynamic/Types/CountryType.php b/Dynamic/Types/CountryType.php
@@ -34,7 +34,10 @@ public function getConfiguration(): FormFieldTypeConfiguration
 
     public function build(FormBuilderInterface $builder, FormField $field, string $locale, array $options): void
     {
-        if (isset($options['attr']['placeholder'])) {
+        if (isset($options['attr'])
+            && \is_array($options['attr'])
+            && isset($options['attr']['placeholder'])
+        ) {
             $options['placeholder'] = $options['attr']['placeholder'];
             unset($options['attr']['placeholder']);
         }

diff --git a/Dynamic/Types/HiddenType.php b/Dynamic/Types/HiddenType.php
@@ -24,9 +24,6 @@ class HiddenType implements FormFieldTypeInterface
 {
     use SimpleTypeTrait;
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfiguration(): FormFieldTypeConfiguration
     {
         return new FormFieldTypeConfiguration(
@@ -35,9 +32,6 @@ public function getConfiguration(): FormFieldTypeConfiguration
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function build(FormBuilderInterface $builder, FormField $field, string $locale, array $options): void
     {
         $type = TypeHiddenType::class;

diff --git a/Dynamic/Types/SimpleTypeTrait.php b/Dynamic/Types/SimpleTypeTrait.php
@@ -25,6 +25,8 @@ trait SimpleTypeTrait
      */
     public function getDefaultValue(FormField $field, string $locale)
     {
-        return $field->getTranslation($locale)->getDefaultValue();
+        $translation = $field->getTranslation($locale);
+
+        return $translation ? $translation->getDefaultValue() : null;
     }
 }