Merged branch '4.6' (PHPStan)

.github/workflows/ci.yaml

@@ -58,7 +58,7 @@ jobs:
                 run: vendor/bin/rector process --dry-run --ansi
 
     tests:
-        name: Unit tests
+        name: Unit tests & PHPStan static analysis
         runs-on: "ubuntu-22.04"
         timeout-minutes: 15
 
@@ -87,6 +87,9 @@ jobs:
             - name: Run unit test suite
               run: composer test
 
+            - name: Run PHPStan analysis
+              run: composer run-script phpstan
+
     integration-tests:
         name: Runs integration tests
         runs-on: "ubuntu-22.04"

composer.json

@@ -35,7 +35,10 @@
         "ibexa/rest": "~5.0.x-dev",
         "ibexa/test-core": "~5.0.x-dev",
         "matthiasnoback/symfony-dependency-injection-test": "^5.0",
-        "phpunit/phpunit": "^9.6"
+        "phpunit/phpunit": "^9.6",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -65,6 +68,7 @@
     "scripts": {
         "fix-cs": "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
         "check-cs": "@fix-cs --dry-run",
+        "phpstan": "phpstan analyse",
         "test": "phpunit -c phpunit.xml.dist",
         "test-integration": "phpunit -c phpunit.integration.xml.dist"
     }

phpstan.neon.dist

@@ -0,0 +1,11 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - phpstan-baseline.neon
+
+parameters:
+    level: 8
+    treatPhpDocTypesAsCertain: false
+    paths:
+        - src
+        - tests

src/lib/Behat/Context/FieldTypeFormContext.php

@@ -20,14 +20,14 @@ final class FieldTypeFormContext extends RawMinkContext implements SnippetAccept
 {
     private static string $fieldIdentifier = 'field';
 
+    /** @var array<string, string> */
     private static array $fieldTypeIdentifierMap = [
         'user' => 'ezuser',
         'textline' => 'ezstring',
         'selection' => 'ezselection',
     ];
 
-    /** @var \Ibexa\ContentForms\Behat\Context\ContentTypeContext */
-    private $contentTypeContext;
+    private ContentTypeContext $contentTypeContext;
 
     /** @BeforeScenario */
     public function gatherContexts(BeforeScenarioScope $scope): void

src/lib/Behat/Context/UserRegistrationContext.php

@@ -275,6 +275,10 @@ public function iSeeARegistrationConfirmationMessage(): void
      */
     public function theUserAccountHasBeenCreated(): void
     {
+        if (null === $this->registrationUsername) {
+            throw new \LogicException('You need to call iFillInTheFormWithValidValues before this step');
+        }
+
         $this->userService->loadUserByLogin($this->registrationUsername);
     }
 
@@ -324,6 +328,10 @@ public function iRegisterAUserAccount(): void
      */
     public function theUserIsCreatedInThisUserGroup(string $userGroupName): void
     {
+        if (null === $this->registrationUsername) {
+            throw new \LogicException('You need to call iFillInTheFormWithValidValues before this step');
+        }
+
         $user = $this->userService->loadUserByLogin($this->registrationUsername);
         $userGroups = $this->userService->loadUserGroupsOfUser($user);
 

src/lib/Data/Content/ContentCreateData.php

@@ -22,7 +22,7 @@ class ContentCreateData extends ContentCreateStruct implements NewnessCheckable
     /**
      * @var \Ibexa\Contracts\Core\Repository\Values\Content\LocationCreateStruct[]
      */
-    private ?array $locationStructs = null;
+    private array $locationStructs = [];
 
     public function isNew(): bool
     {
@@ -32,16 +32,14 @@ public function isNew(): bool
     /**
      * @return \Ibexa\Contracts\Core\Repository\Values\Content\LocationCreateStruct[]
      */
-    public function getLocationStructs()
+    public function getLocationStructs(): array
     {
         return $this->locationStructs;
     }
 
     /**
      * Adds a location struct.
      * A location will be created out of it, bound to the created content.
-     *
-     * @param \Ibexa\Contracts\Core\Repository\Values\Content\LocationCreateStruct $locationStruct
      */
     public function addLocationStruct(LocationCreateStruct $locationStruct): void
     {

src/lib/Data/Mapper/UserUpdateMapper.php

@@ -49,7 +49,7 @@ public function mapToFormData(User $user, ContentType $contentType, array $param
 
         $filter = $params['filter'];
 
-        $fields = $user->getFieldsByLanguage($params['languageCode']);
+        $fields = iterator_to_array($user->getFieldsByLanguage($params['languageCode']));
         foreach ($contentType->fieldDefinitions as $fieldDef) {
             $field = $fields[$fieldDef->identifier];
 

src/lib/Data/User/UserCreateData.php

@@ -25,7 +25,7 @@ class UserCreateData extends UserCreateStruct implements NewnessCheckable
     /**
      * @var \Ibexa\Contracts\Core\Repository\Values\User\UserGroup[]
      */
-    private ?array $parentGroups = null;
+    private array $parentGroups = [];
 
     private ?Role $role = null;
 
@@ -39,7 +39,7 @@ public function isNew(): bool
     /**
      * @return \Ibexa\Contracts\Core\Repository\Values\User\UserGroup[]
      */
-    public function getParentGroups()
+    public function getParentGroups(): array
     {
         return $this->parentGroups;
     }

src/lib/Event/FormActionEvent.php

@@ -16,53 +16,54 @@ class FormActionEvent extends FormEvent
 {
     /**
      * Name of the button used to submit the form.
-     *
-     * @var string
      */
-    private $clickedButton;
+    private string $clickedButton;
 
     /**
      * Hash of options.
+     *
+     * @var array<string, mixed>
      */
     private array $options;
 
     /**
-     * Response to return after form post-processing. Typically a RedirectResponse.
+     * Response to return after form post-processing. Typically, a RedirectResponse.
      */
     private ?Response $response = null;
 
     /**
      * Additional payload populated for event listeners next in priority.
+     *
+     * @var array<string, mixed>
      */
     private array $payloads;
 
     /**
-     * @param \Symfony\Component\Form\FormInterface $form
-     * @param $data
-     * @param $clickedButton
-     * @param array $options
-     * @param array $payloads
+     * @param array<string, mixed> $options
+     * @param array<string, mixed> $payloads
      */
-    public function __construct(FormInterface $form, mixed $data, $clickedButton, array $options = [], array $payloads = [])
-    {
+    public function __construct(
+        FormInterface $form,
+        mixed $data,
+        string $clickedButton,
+        array $options = [],
+        array $payloads = []
+    ) {
         parent::__construct($form, $data);
         $this->clickedButton = $clickedButton;
         $this->options = $options;
         $this->payloads = $payloads;
     }
 
-    /**
-     * @return string
-     */
-    public function getClickedButton()
+    public function getClickedButton(): string
     {
         return $this->clickedButton;
     }
 
     /**
-     * @return array
+     * @return array<string, mixed>
      */
-    public function getOptions()
+    public function getOptions(): array
     {
         return $this->options;
     }
@@ -73,7 +74,7 @@ public function getOptions()
      *
      * @return mixed
      */
-    public function getOption($optionName, $defaultValue = null)
+    public function getOption(string $optionName, mixed $defaultValue = null): mixed
     {
         if (!isset($this->options[$optionName])) {
             return $defaultValue;
@@ -82,27 +83,16 @@ public function getOption($optionName, $defaultValue = null)
         return $this->options[$optionName];
     }
 
-    /**
-     * @param string $optionName
-     *
-     * @return bool
-     */
-    public function hasOption($optionName): bool
+    public function hasOption(string $optionName): bool
     {
         return isset($this->options[$optionName]);
     }
 
-    /**
-     * @return \Symfony\Component\HttpFoundation\Response
-     */
-    public function getResponse()
+    public function getResponse(): ?Response
     {
         return $this->response;
     }
 
-    /**
-     * @param \Symfony\Component\HttpFoundation\Response $response
-     */
     public function setResponse(Response $response): void
     {
         $this->response = $response;
@@ -114,46 +104,32 @@ public function hasResponse(): bool
     }
 
     /**
-     * @return array
+     * @return array<string, mixed>
      */
     public function getPayloads(): array
     {
         return $this->payloads;
     }
 
     /**
-     * @param array $payloads
+     * @param array<string, mixed> $payloads
      */
     public function setPayloads(array $payloads): void
     {
         $this->payloads = $payloads;
     }
 
-    /**
-     * @param string $name
-     *
-     * @return bool
-     */
     public function hasPayload(string $name): bool
     {
         return isset($this->payloads[$name]);
     }
 
-    /**
-     * @param string $name
-     *
-     * @return mixed
-     */
-    public function getPayload(string $name)
+    public function getPayload(string $name): mixed
     {
         return $this->payloads[$name];
     }
 
-    /**
-     * @param string $name
-     * @param mixed $payload
-     */
-    public function setPayload(string $name, $payload): void
+    public function setPayload(string $name, mixed $payload): void
     {
         $this->payloads[$name] = $payload;
     }

src/lib/FieldType/DataTransformer/AbstractBinaryBaseTransformer.php

@@ -10,38 +10,33 @@
 
 use Ibexa\Contracts\Core\Repository\FieldType;
 use Ibexa\Core\FieldType\Value;
-use Symfony\Component\Form\Exception\TransformationFailedException;
 
 /**
- * Base transformer for binary file based field types.
- *
- * {@inheritdoc}
+ * Base transformer for binary file-based field types.
  */
 abstract class AbstractBinaryBaseTransformer
 {
     protected FieldType $fieldType;
 
     protected Value $initialValue;
 
-    /** @var string */
-    protected $valueClass;
+    /** @phpstan-var class-string */
+    protected string $valueClass;
 
     /**
-     * @param \Ibexa\Contracts\Core\Repository\FieldType $fieldType
-     * @param \Ibexa\Core\FieldType\Value $initialValue
-     * @param string $valueClass
+     * @phpstan-param class-string $valueClass
      */
-    public function __construct(FieldType $fieldType, Value $initialValue, $valueClass)
+    public function __construct(FieldType $fieldType, Value $initialValue, string $valueClass)
     {
         $this->fieldType = $fieldType;
         $this->initialValue = $initialValue;
         $this->valueClass = $valueClass;
     }
 
     /**
-     * @return array|null
+     * @return array{file: string|null, remove: bool}
      */
-    public function getDefaultProperties()
+    public function getDefaultProperties(): array
     {
         return [
             'file' => null,
@@ -50,23 +45,17 @@ public function getDefaultProperties()
     }
 
     /**
-     * @param array $value
-     *
-     * @return \Ibexa\Core\FieldType\Value
+     * @param array<string, mixed> $value
      *
      * @throws \Symfony\Component\Form\Exception\TransformationFailedException
      */
-    public function getReverseTransformedValue($value)
+    public function getReverseTransformedValue(array $value): Value
     {
-        if (!is_array($value)) {
-            throw new TransformationFailedException(sprintf('Received %s instead of an array', gettype($value)));
-        }
-
         if ($value['remove']) {
             return $this->fieldType->getEmptyValue();
         }
 
-        /* in case file is not modified, overwrite settings only */
+        /* in case the file is not modified, overwrite settings only */
         if (null === $value['file']) {
             return clone $this->initialValue;
         }