IBX-9727: Added type-hints and adapted codebase to PHP8+

Author: konradoboza

.php-cs-fixer.php

@@ -8,18 +8,11 @@
 
 use Ibexa\CodeStyle\PhpCsFixer\InternalConfigFactory;
 
-$configFactory = new InternalConfigFactory();
-$configFactory->withRules([
-    'declare_strict_types' => false,
-]);
-
-return $configFactory
-    ->buildConfig()
-    ->setFinder(
-        PhpCsFixer\Finder::create()
-            ->in([
-                __DIR__ . '/src',
-                __DIR__ . '/tests',
-            ])
-            ->files()->name('*.php')
+return (new InternalConfigFactory())->buildConfig()->setFinder(
+    PhpCsFixer\Finder::create()
+        ->in([
+            __DIR__ . '/src',
+            __DIR__ . '/tests',
+        ])
+        ->files()->name('*.php')
     );

phpstan-baseline.neon

@@ -20,59 +20,31 @@
 use Ibexa\Contracts\Core\Repository\ContentService;
 use Ibexa\Contracts\Core\Repository\ContentTypeService;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 
-class ContentEditController extends Controller
+final class ContentEditController extends Controller
 {
-    private ContentTypeService $contentTypeService;
-
-    private ContentService $contentService;
-
-    private ActionDispatcherInterface $contentActionDispatcher;
-
     public function __construct(
-        ContentTypeService $contentTypeService,
-        ContentService $contentService,
-        ActionDispatcherInterface $contentActionDispatcher
+        private readonly ContentTypeService $contentTypeService,
+        private readonly ContentService $contentService,
+        private readonly ActionDispatcherInterface $contentActionDispatcher
     ) {
-        $this->contentTypeService = $contentTypeService;
-        $this->contentService = $contentService;
-        $this->contentActionDispatcher = $contentActionDispatcher;
     }
 
     /**
      * Displays and processes a content creation form. Showing the form does not create a draft in the repository.
-     *
-     * @param \Ibexa\ContentForms\Content\View\ContentCreateView $view
-     *
-     * @return \Ibexa\ContentForms\Content\View\ContentCreateView
      */
     public function createWithoutDraftAction(ContentCreateView $view): ContentCreateView
     {
         return $view;
     }
 
-    /**
-     * @param \Ibexa\ContentForms\Content\View\ContentCreateSuccessView $view
-     *
-     * @return \Ibexa\ContentForms\Content\View\ContentCreateSuccessView
-     *
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
-     */
     public function createWithoutDraftSuccessAction(ContentCreateSuccessView $view): ContentCreateSuccessView
     {
         return $view;
     }
 
     /**
-     * Displays a draft creation form that creates a content draft from an existing content.
-     *
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     * @param int|null $contentId
-     * @param int $fromVersionNo
-     * @param string $fromLanguage
-     *
-     * @return \Ibexa\ContentForms\Content\View\ContentCreateDraftView|\Symfony\Component\HttpFoundation\Response
-     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
      * @throws \Ibexa\Core\Base\Exceptions\InvalidArgumentType
@@ -82,7 +54,7 @@ public function createContentDraftAction(
         ?int $contentId = null,
         ?int $fromVersionNo = null,
         ?string $fromLanguage = null
-    ) {
+    ): ContentCreateDraftView|Response {
         $createContentDraft = new CreateContentDraftData();
         $contentInfo = null;
         $contentType = null;
@@ -93,7 +65,7 @@ public function createContentDraftAction(
             $contentInfo = $this->contentService->loadContentInfo($contentId);
             $contentType = $this->contentTypeService->loadContentType($contentInfo->contentTypeId);
             $createContentDraft->fromVersionNo = $fromVersionNo ?: $contentInfo->currentVersionNo;
-            $createContentDraft->fromLanguage = $fromLanguage ?: $contentInfo->mainLanguageCode;
+            $createContentDraft->fromLanguage = $fromLanguage ?: $contentInfo->getMainLanguageCode();
         }
 
         $form = $this->createForm(
@@ -120,25 +92,11 @@ public function createContentDraftAction(
         ]);
     }
 
-    /**
-     * @param \Ibexa\ContentForms\Content\View\ContentEditView $view
-     *
-     * @return \Ibexa\ContentForms\Content\View\ContentEditView
-     *
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
-     */
     public function editVersionDraftAction(ContentEditView $view): ContentEditView
     {
         return $view;
     }
 
-    /**
-     * @param \Ibexa\ContentForms\Content\View\ContentEditSuccessView $view
-     *
-     * @return \Ibexa\ContentForms\Content\View\ContentEditSuccessView
-     *
-     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
-     */
     public function editVersionDraftSuccessAction(ContentEditSuccessView $view): ContentEditSuccessView
     {
         return $view;

src/bundle/Controller/ContentEditController.php

@@ -27,59 +27,24 @@
 use Ibexa\Core\Base\Exceptions\UnauthorizedException as CoreUnauthorizedException;
 use Ibexa\Core\MVC\Symfony\Locale\UserLanguagePreferenceProviderInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 
-class UserController extends Controller
+final class UserController extends Controller
 {
-    private ContentTypeService $contentTypeService;
-
-    private UserService $userService;
-
-    private LocationService $locationService;
-
-    private LanguageService $languageService;
-
-    private ActionDispatcherInterface $userActionDispatcher;
-
-    private PermissionResolver $permissionResolver;
-
-    private UserLanguagePreferenceProviderInterface $userLanguagePreferenceProvider;
-
-    private GroupedContentFormFieldsProviderInterface $groupedContentFormFieldsProvider;
-
-    private ContentService $contentService;
-
     public function __construct(
-        ContentTypeService $contentTypeService,
-        UserService $userService,
-        LocationService $locationService,
-        LanguageService $languageService,
-        ActionDispatcherInterface $userActionDispatcher,
-        PermissionResolver $permissionResolver,
-        UserLanguagePreferenceProviderInterface $userLanguagePreferenceProvider,
-        GroupedContentFormFieldsProviderInterface $groupedContentFormFieldsProvider,
-        ContentService $contentService
+        private readonly ContentTypeService $contentTypeService,
+        private readonly UserService $userService,
+        private readonly LocationService $locationService,
+        private readonly LanguageService $languageService,
+        private readonly ActionDispatcherInterface $userActionDispatcher,
+        private readonly PermissionResolver $permissionResolver,
+        private readonly UserLanguagePreferenceProviderInterface $userLanguagePreferenceProvider,
+        private readonly GroupedContentFormFieldsProviderInterface $groupedContentFormFieldsProvider,
+        private readonly ContentService $contentService
     ) {
-        $this->contentTypeService = $contentTypeService;
-        $this->userService = $userService;
-        $this->locationService = $locationService;
-        $this->languageService = $languageService;
-        $this->userActionDispatcher = $userActionDispatcher;
-        $this->permissionResolver = $permissionResolver;
-        $this->userLanguagePreferenceProvider = $userLanguagePreferenceProvider;
-        $this->groupedContentFormFieldsProvider = $groupedContentFormFieldsProvider;
-        $this->contentService = $contentService;
     }
 
     /**
-     * Displays and processes a user creation form.
-     *
-     * @param string $contentTypeIdentifier ContentType id to create
-     * @param string $language Language code to create the content in (eng-GB, ger-DE, ...))
-     * @param int $parentLocationId Location the content should be a child of
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\Response|\Ibexa\ContentForms\User\View\UserCreateView
-     *
      * @throws \Ibexa\Core\Base\Exceptions\InvalidArgumentType
      * @throws \Ibexa\Core\Base\Exceptions\InvalidArgumentException
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
@@ -96,21 +61,22 @@ public function createAction(
         string $language,
         int $parentLocationId,
         Request $request
-    ) {
+    ): Response|UserCreateView {
         $contentType = $this->contentTypeService->loadContentTypeByIdentifier(
             $contentTypeIdentifier,
             $this->userLanguagePreferenceProvider->getPreferredLanguages()
         );
         $location = $this->locationService->loadLocation($parentLocationId);
         $language = $this->languageService->loadLanguage($language);
-        $parentGroup = $this->userService->loadUserGroup($location->contentId);
+        $languageCode = $language->getLanguageCode();
+        $parentGroup = $this->userService->loadUserGroup($location->getContentId());
 
         $data = (new UserCreateMapper())->mapToFormData($contentType, [$parentGroup], [
-            'mainLanguageCode' => $language->languageCode,
+            'mainLanguageCode' => $languageCode,
         ]);
         $form = $this->createForm(UserCreateType::class, $data, [
-            'languageCode' => $language->languageCode,
-            'mainLanguageCode' => $language->languageCode,
+            'languageCode' => $languageCode,
+            'mainLanguageCode' => $languageCode,
             'struct' => $data,
         ]);
         $form->handleRequest($request);
@@ -138,15 +104,6 @@ public function createAction(
     }
 
     /**
-     * Displays a user update form that updates user data and related content item.
-     *
-     * @param int $contentId ContentType id to create
-     * @param int $versionNo Version number the version should be created from. Defaults to the currently published one.
-     * @param string $language Language code to create the version in (eng-GB, ger-DE, ...))
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\Response|\Ibexa\ContentForms\User\View\UserUpdateView
-     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
@@ -159,13 +116,13 @@ public function editAction(
         int $versionNo,
         string $language,
         Request $request
-    ) {
+    ): Response|UserUpdateView {
         $user = $this->userService->loadUser($contentId);
         if (!$this->permissionResolver->canUser('content', 'edit', $user)) {
             throw new CoreUnauthorizedException('content', 'edit', ['userId' => $contentId]);
         }
         $contentType = $this->contentTypeService->loadContentType(
-            $user->contentInfo->contentTypeId,
+            $user->getContentInfo()->getContentType()->id,
             $this->userLanguagePreferenceProvider->getPreferredLanguages()
         );
 
@@ -176,12 +133,12 @@ public function editAction(
         try {
             // assume main location if no location was provided
             $location = $this->locationService->loadLocation(
-                (int)$user->versionInfo->contentInfo->mainLocationId
+                (int)$user->getVersionInfo()->getContentInfo()->getMainLocationId()
             );
         } catch (UnauthorizedException $e) {
             // if no access to the main location assume content has multiple locations and first of them can be used
             $availableLocations = $this->locationService->loadLocations(
-                $user->versionInfo->contentInfo
+                $user->getVersionInfo()->getContentInfo()
             );
             $location = array_shift($availableLocations);
         }
@@ -193,7 +150,7 @@ public function editAction(
                 'location' => $location,
                 'content' => $this->contentService->loadContent($contentId),
                 'languageCode' => $language,
-                'mainLanguageCode' => $user->contentInfo->mainLanguageCode,
+                'mainLanguageCode' => $user->getContentInfo()->getMainLanguageCode(),
                 'struct' => $userUpdate,
             ],
         );
@@ -209,7 +166,8 @@ public function editAction(
         $parentLocation = null;
         try {
             $parentLocation = $this->locationService->loadLocation($location->parentLocationId);
-        } catch (UnauthorizedException $e) {
+        } catch (UnauthorizedException) {
+            //do nothing
         }
 
         return new UserUpdateView(

src/bundle/Controller/UserController.php

@@ -14,10 +14,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-/**
- * Compiler pass to register FieldType form mappers in the mapper dispatcher.
- */
-class FieldTypeFormMapperDispatcherPass implements CompilerPassInterface
+final class FieldTypeFormMapperDispatcherPass implements CompilerPassInterface
 {
     public const string FIELD_TYPE_FORM_MAPPER_DISPATCHER = FieldTypeFormMapperDispatcher::class;
     public const string FIELD_TYPE_FORM_MAPPER_VALUE_SERVICE_TAG = 'ibexa.admin_ui.field_type.form.mapper.value';
@@ -46,7 +43,10 @@ public function process(ContainerBuilder $container): void
                     );
                 }
 
-                $dispatcherDefinition->addMethodCall('addMapper', [new Reference($serviceId), $tag['fieldType']]);
+                $dispatcherDefinition->addMethodCall(
+                    'addMapper',
+                    [new Reference($serviceId), $tag['fieldType']]
+                );
             }
         }
     }

src/bundle/DependencyInjection/Compiler/FieldTypeFormMapperDispatcherPass.php

@@ -10,8 +10,8 @@
 
 use Ibexa\Bundle\Core\DependencyInjection\Configuration\Parser\View;
 
-class ContentCreateView extends View
+final class ContentCreateView extends View
 {
-    public const NODE_KEY = 'content_create_view';
-    public const INFO = 'Template selection settings when displaying a content create form';
+    public const string NODE_KEY = 'content_create_view';
+    public const string INFO = 'Template selection settings when displaying a content create form';
 }