refactor: corrected some PHPStan issues

Author: thorsten

phpmyfaq/src/phpMyFAQ/Auth.php

@@ -107,7 +107,7 @@ public function error(): string
      * @param string $method Authentication access methods
      * @throws Exception
      */
-    public function selectAuth(string $method): AuthDriverInterface
+    public function selectAuth(string $method): Auth
     {
         // verify selected authentication
         $method = ucfirst(strtolower($method));

phpmyfaq/src/phpMyFAQ/Setup/Upgrade.php

@@ -79,18 +79,23 @@ public function checkFilesystem(): bool
         if (!is_dir(PMF_ROOT_DIR . '/assets/themes')) {
             throw new Exception('The folder /phpmyfaq/assets/themes is missing.');
         }
+
         if (!is_dir(PMF_CONTENT_DIR . '/user/attachments')) {
             return false;
         }
+
         if (!is_dir(PMF_CONTENT_DIR . '/user/images')) {
             return false;
         }
+
         if (!is_dir(PMF_CONTENT_DIR . '/core/data')) {
             return false;
         }
+
         if (!is_dir(PMF_ROOT_DIR . '/assets/themes')) {
             return false;
         }
+
         if (
             is_file(PMF_CONTENT_DIR . '/core/config/constants.php') &&
             is_file(PMF_CONTENT_DIR . '/core/config/database.php')

phpmyfaq/src/phpMyFAQ/Template/TwigWrapper.php

@@ -66,6 +66,6 @@ public function addFunction(TwigFunction $twigFunction): void
 
     public function getExtension(string $class): ExtensionInterface
     {
-        return $this->twigEnvironment->getExtension($class);
+        return $this->twigEnvironment->getExtension($class); /** @phpstan-ignore-line */
     }
 }

phpmyfaq/src/phpMyFAQ/Translation.php

@@ -146,19 +146,20 @@ public function setMultiByteLanguage(): void
 
     /**
      * Returns the configuration items from the current language for the given section.
+     *
+     * @return array<string, array<string, string>>
      */
     public static function getConfigurationItems(string $section = ''): array
     {
-        include self::$translation->filename(self::$translation->currentLanguage);
-
         $configuration = [];
 
-        foreach ($LANG_CONF as $key => $value) {
-            if (str_starts_with((string) $key, $section)) {
+        foreach (self::fetchTranslationFile() as $key => $value) {
+            if (str_starts_with($key, $section)) {
                 $configuration[$key] = ['element' => $value[0] ?? '', 'label' => $value[1] ?? ''];
 
                 switch ($key) {
                     case 'records.maxAttachmentSize':
+                        /** @phpstan-ignore-next-line */
                         $configuration[$key]['label'] = sprintf(
                             $configuration[$key]['label'],
                             ini_get('upload_max_filesize')
@@ -267,4 +268,16 @@ protected function filename(string $language): string
     {
         return self::$translation->languagesDir . DIRECTORY_SEPARATOR . 'language_' . $language . '.php';
     }
+
+    /**
+     * Fetches the translation file for the current language.
+     * @return array<string, array<string, string>>
+     */
+    private static function fetchTranslationFile(): array
+    {
+        $LANG_CONF = [];
+        include self::$translation->filename(self::$translation->currentLanguage);
+
+        return $LANG_CONF;
+    }
 }

phpmyfaq/src/phpMyFAQ/User.php

@@ -67,8 +67,6 @@ class User
     final public const ERROR_USER_LOGIN_INVALID = 'The chosen login is invalid. A valid login has at least four ' .
         'characters. Only letters, numbers and underscore _ are allowed. The first letter must be a letter. ';
 
-    final public const ERROR_USER_NO_PERM = 'No permission container specified.';
-
     final public const ERROR_USER_NO_USERID = 'No user-ID found. ';
 
     final public const ERROR_USER_NO_USERLOGINDATA = 'No user login data found. ';
@@ -106,7 +104,7 @@ class User
     /**
      * authentication container.
      *
-     * @var array<string, AuthDriverInterface>
+     * @var array<string, Auth|AuthDriverInterface>
      */
     protected array $authContainer = [];
 
@@ -240,10 +238,10 @@ public function getAuthData(string $key): mixed
     /**
      * adds a new authentication object to the user object.
      *
-     * @param AuthDriverInterface $authDriver Driver object
+     * @param Auth $authDriver Driver object
      * @param string                                                          $name Auth name
      */
-    public function addAuth(AuthDriverInterface $authDriver, string $name): bool
+    public function addAuth(Auth $authDriver, string $name): bool
     {
         if ($this->checkAuth($authDriver)) {
             $this->authContainer[$name] = $authDriver;
@@ -257,9 +255,9 @@ public function addAuth(AuthDriverInterface $authDriver, string $name): bool
     /**
      * Returns true if auth is a valid authentication object.
      *
-     * @param AuthDriverInterface $auth Auth object
+     * @param Auth $auth Auth object
      */
-    protected function checkAuth(AuthDriverInterface $auth): bool
+    protected function checkAuth(Auth $auth): bool
     {
         $methods = ['checkCredentials'];
         foreach ($methods as $method) {
@@ -359,10 +357,10 @@ public function checkMailAddress(string $name): bool
     }
 
     /**
-     * search users by login.
+     * Search users by login.
      *
      * @param string $search Login name
-     * @return array<int, array>
+     * @return array<string[]>
      */
     public function searchUsers(string $search): array
     {
@@ -626,6 +624,7 @@ public function deleteUser(): bool
             return false;
         }
 
+        /** @phpstan-ignore-next-line */
         $this->perm->refuseAllUserRights($this->userId);
 
         $delete = sprintf(