[5.1] phan: fixes plugins

.phan/config.php

@@ -49,8 +49,8 @@
     //
     // Note that the **only** effect of choosing `'5.6'` is to infer that functions removed in php 7.0 exist.
     // (See `backward_compatibility_checks` for additional options)
-    // Automatically inferred from composer.json requirement for "php" of "^7.2.5"
-    'target_php_version' => '7.2',
+    // Automatically inferred from composer.json requirement for "php" of "^8.1.0"
+    'target_php_version' => '8.1',
 
     // If enabled, missing properties will be created when
     // they are first seen. If false, we'll report an

administrator/components/com_fields/src/Plugin/FieldsListPlugin.php

@@ -31,7 +31,7 @@ class FieldsListPlugin extends FieldsPlugin
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

administrator/components/com_fields/src/Plugin/FieldsPlugin.php

@@ -201,7 +201,7 @@ public function onCustomFieldsGetTypes()
      * @param   \stdclass  $item     The item.
      * @param   \stdclass  $field    The field.
      *
-     * @return  string
+     * @return  ?string
      *
      * @since   3.7.0
      */
@@ -235,7 +235,7 @@ public function onCustomFieldsPrepareField($context, $item, $field)
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

libraries/src/Changelog/Changelog.php

@@ -122,7 +122,7 @@ class Changelog
     /**
      * Resource handle for the XML Parser
      *
-     * @var    resource
+     * @var    \XMLParser
      * @since  4.0.0
      */
     protected $xmlParser;

libraries/src/Image/Image.php

@@ -137,7 +137,7 @@ public function __construct($source = null)
     /**
      * Get the image resource handle
      *
-     * @return  resource
+     * @return  \GdImage
      *
      * @since   3.8.0
      * @throws  \LogicException if an image has not been loaded into the instance

libraries/src/Image/ImageFilter.php

@@ -21,7 +21,7 @@
 abstract class ImageFilter
 {
     /**
-     * @var    resource  The image resource handle.
+     * @var    \GdImage  The image resource handle.
      * @since  2.5.0
      */
     protected $handle;

libraries/src/Updater/Update.php

@@ -176,7 +176,7 @@ class Update
     /**
      * Resource handle for the XML Parser
      *
-     * @var    resource
+     * @var    \XMLParser
      * @since  3.0.0
      */
     protected $xmlParser;

libraries/src/Updater/UpdateAdapter.php

@@ -32,7 +32,7 @@ abstract class UpdateAdapter extends AdapterInstance
     /**
      * Resource handle for the XML Parser
      *
-     * @var    resource
+     * @var    \XMLParser
      * @since  3.0.0
      */
     protected $xmlParser;

plugins/actionlog/joomla/src/Extension/Joomla.php

@@ -896,7 +896,7 @@ protected function checkLoggable($extension)
      *
      * Method is called after user request to remind their username.
      *
-     * @param   array  $user  Holds the user data.
+     * @param   object  $user  Holds the user data.
      *
      * @return  void
      *
@@ -1127,7 +1127,7 @@ public function onJoomlaAfterUpdate($oldVersion = null)
      *
      * @param   string  $context  The context of the action log
      *
-     * @return  \stdClass  The params
+     * @return  ?\stdClass  The params
      *
      * @since   4.2.0
      */
@@ -1147,7 +1147,7 @@ private function getActionLogParams($context): ?\stdClass
      *
      * Method is called after user request to reset their password.
      *
-     * @param   array  $user  Holds the user data.
+     * @param   object  $user  Holds the user data.
      *
      * @return  void
      *
@@ -1180,7 +1180,7 @@ public function onUserAfterResetRequest($user)
      *
      * Method is called after user complete the reset of their password.
      *
-     * @param   array  $user  Holds the user data.
+     * @param   object  $user  Holds the user data.
      *
      * @return  void
      *

plugins/api-authentication/token/src/Extension/Token.php

@@ -15,7 +15,6 @@
 use Joomla\CMS\Event\User\AuthenticationEvent;
 use Joomla\CMS\Plugin\CMSPlugin;
 use Joomla\CMS\User\UserFactoryAwareTrait;
-use Joomla\Component\Plugins\Administrator\Model\PluginModel;
 use Joomla\Database\DatabaseAwareTrait;
 use Joomla\Database\ParameterType;
 use Joomla\Event\DispatcherInterface;
@@ -327,7 +326,7 @@ private function isTokenEnabledForUser(int $userId): bool
      */
     private function getPluginParameter(string $folder, string $plugin, string $param, $default = null)
     {
-        /** @var PluginModel $model */
+        /** @var \Joomla\Component\Plugins\Administrator\Model\PluginModel $model */
         $model = $this->getApplication()->bootComponent('plugins')
             ->getMVCFactory()->createModel('Plugin', 'Administrator', ['ignore_request' => true]);
 

plugins/behaviour/compat/src/Extension/Compat.php

@@ -13,7 +13,6 @@
 use Joomla\CMS\Event\Application\AfterInitialiseDocumentEvent;
 use Joomla\CMS\Plugin\CMSPlugin;
 use Joomla\Event\DispatcherInterface;
-use Joomla\Event\Event;
 use Joomla\Event\Priority;
 use Joomla\Event\SubscriberInterface;
 
@@ -80,7 +79,7 @@ public function __construct(DispatcherInterface $dispatcher, array $config = [])
     /**
      * We run as early as possible, this should be the first event
      *
-     * @param Event $event
+     * @param  AfterInitialiseDocumentEvent $event
      * @return void
      *
      * @since  5.0.0

plugins/editors/codemirror/layouts/editors/codemirror/codemirror.php

@@ -20,7 +20,7 @@
 /**
  * Layout variables
  *
- * @var   array    $options     JS options for editor
+ * @var   object   $options     JS options for editor
  * @var   Registry $params      Plugin parameters
  * @var   string   $id          The id of the input
  * @var   string   $name        The name of the input

plugins/fields/calendar/src/Extension/Calendar.php

@@ -32,7 +32,7 @@ final class Calendar extends FieldsPlugin implements SubscriberInterface
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/fields/color/src/Extension/Color.php

@@ -32,7 +32,7 @@ final class Color extends FieldsPlugin implements SubscriberInterface
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/fields/editor/src/Extension/Editor.php

@@ -32,7 +32,7 @@ final class Editor extends FieldsPlugin implements SubscriberInterface
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/fields/imagelist/src/Extension/Imagelist.php

@@ -32,7 +32,7 @@ final class Imagelist extends FieldsPlugin implements SubscriberInterface
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/fields/list/src/Extension/ListPlugin.php

@@ -63,7 +63,7 @@ public function onCustomFieldsBeforePrepareField($context, $item, $field)
      * @param   \stdclass  $item     The item.
      * @param   \stdclass  $field    The field.
      *
-     * @return  object
+     * @return  ?string
      *
      * @since   3.9.2
      */

plugins/fields/media/src/Extension/Media.php

@@ -31,7 +31,7 @@ final class Media extends FieldsPlugin
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   4.0.0
      */

plugins/fields/sql/src/Extension/SQL.php

@@ -32,7 +32,7 @@ final class SQL extends FieldsListPlugin
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/fields/subform/src/Extension/Subform.php

@@ -140,7 +140,7 @@ public function onCustomFieldsBeforePrepareField($context, $item, $field)
      * @param   object     $item     The item
      * @param   \stdClass  $field    The field
      *
-     * @return  string
+     * @return  ?string
      *
      * @since 4.0.0
      */
@@ -242,7 +242,7 @@ public function onCustomFieldsPrepareField($context, $item, $field)
      * @param   \DOMElement  $parent  The original parent element
      * @param   Form        $form    The form
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since 4.0.0
      */

plugins/fields/url/src/Extension/Url.php

@@ -32,7 +32,7 @@ final class Url extends FieldsPlugin implements SubscriberInterface
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/fields/user/src/Extension/User.php

@@ -35,7 +35,7 @@ final class User extends FieldsPlugin implements SubscriberInterface
      * @param   \DOMElement  $parent  The field node parent.
      * @param   Form         $form    The form.
      *
-     * @return  \DOMElement
+     * @return  ?\DOMElement
      *
      * @since   3.7.0
      */

plugins/installer/packageinstaller/tmpl/default.php

@@ -13,9 +13,8 @@
 use Joomla\CMS\Filesystem\FilesystemHelper;
 use Joomla\CMS\HTML\HTMLHelper;
 use Joomla\CMS\Language\Text;
-use Joomla\Plugin\Installer\Package\Extension\PackageInstaller;
 
-/** @var PackageInstaller $this */
+/** @var \Joomla\Plugin\Installer\Package\Extension\PackageInstaller $this */
 
 HTMLHelper::_('form.csrf');
 

plugins/installer/urlinstaller/tmpl/default.php

@@ -11,9 +11,8 @@
 defined('_JEXEC') or die;
 
 use Joomla\CMS\Language\Text;
-use Joomla\Plugin\Installer\Url\Extension\UrlInstaller;
 
-/** @var UrlInstaller $this */
+/** @var \Joomla\Plugin\Installer\Url\Extension\UrlInstaller $this */
 
 $this->getApplication()->getDocument()->getWebAssetManager()
     ->registerAndUseScript('plg_installer_urlinstaller.urlinstaller', 'plg_installer_urlinstaller/urlinstaller.js', [], ['defer' => true], ['core']);

plugins/multifactorauth/webauthn/src/Helper/Credentials.php

@@ -20,7 +20,6 @@
 use Joomla\Plugin\Multifactorauth\Webauthn\CredentialRepository;
 use Joomla\Session\SessionInterface;
 use Laminas\Diactoros\ServerRequestFactory;
-use Webauthn\AttestedCredentialData;
 use Webauthn\AuthenticationExtensions\AuthenticationExtensionsClientInputs;
 use Webauthn\AuthenticatorSelectionCriteria;
 use Webauthn\PublicKeyCredentialCreationOptions;
@@ -89,7 +88,7 @@ public static function requestAttestation(User $user): string
      *
      * @param   string   $data   The JSON-encoded data returned by the browser during the authentication flow
      *
-     * @return  AttestedCredentialData|null
+     * @return  ?PublicKeyCredentialSource
      * @throws  \Exception  When something does not check out
      * @since   4.2.0
      */

plugins/privacy/consents/src/Extension/Consents.php

@@ -32,7 +32,7 @@ final class Consents extends PrivacyPlugin
      * This event will collect data for the core `#__privacy_consents` table
      *
      * @param   RequestTable  $request  The request record being processed
-     * @param   User          $user     The user account associated with this request if available
+     * @param   ?User         $user     The user account associated with this request if available
      *
      * @return  \Joomla\Component\Privacy\Administrator\Export\Domain[]
      *

plugins/privacy/contact/src/Extension/Contact.php

@@ -34,7 +34,7 @@ final class Contact extends PrivacyPlugin
      * - Contact custom fields
      *
      * @param   RequestTable  $request  The request record being processed
-     * @param   User          $user     The user account associated with this request if available
+     * @param   ?User         $user     The user account associated with this request if available
      *
      * @return  \Joomla\Component\Privacy\Administrator\Export\Domain[]
      *

plugins/privacy/content/src/Extension/Content.php

@@ -33,7 +33,7 @@ final class Content extends PrivacyPlugin
      * - Content custom fields
      *
      * @param   RequestTable  $request  The request record being processed
-     * @param   User          $user     The user account associated with this request if available
+     * @param   ?User         $user     The user account associated with this request if available
      *
      * @return  \Joomla\Component\Privacy\Administrator\Export\Domain[]
      *

plugins/privacy/message/src/Extension/Message.php

@@ -32,7 +32,7 @@ final class Message extends PrivacyPlugin
      * This event will collect data for the message table
      *
      * @param   RequestTable  $request  The request record being processed
-     * @param   User          $user     The user account associated with this request if available
+     * @param   ?User         $user     The user account associated with this request if available
      *
      * @return  \Joomla\Component\Privacy\Administrator\Export\Domain[]
      *

plugins/system/actionlogs/src/Extension/ActionLogs.php

@@ -353,9 +353,9 @@ public static function renderActionlogsExtensions($extensions)
      * On Saving extensions logging method
      * Method is called when an extension is being saved
      *
-     * @param   string   $context  The extension
-     * @param   Table    $table    DataBase Table object
-     * @param   boolean  $isNew    If the extension is new or not
+     * @param   string                   $context  The extension
+     * @param   \Joomla\CMS\Table\Table  $table    DataBase Table object
+     * @param   boolean                  $isNew    If the extension is new or not
      *
      * @return  void
      *

plugins/system/fields/src/Extension/Fields.php

@@ -219,7 +219,7 @@ public function onContentAfterDelete($context, $item): void
     /**
      * The user delete event.
      *
-     * @param   \stdClass  $user    The context
+     * @param   array     $user    The context
      * @param   boolean   $success Is success
      * @param   string    $msg     The message
      *

plugins/system/webauthn/src/Authentication.php

@@ -212,7 +212,7 @@ public function getPubKeyCreationOptions(User $user): PublicKeyCredentialCreatio
      *
      * @param   User  $user  The Joomla user to get the PK request options for
      *
-     * @return  PublicKeyCredentialRequestOptions
+     * @return  ?PublicKeyCredentialRequestOptions
      *
      * @throws  \Exception
      * @since   4.2.0
@@ -289,7 +289,7 @@ public function validateAssertionResponse(string $data, User $user): PublicKeyCr
      *
      * @param   string  $data  The data
      *
-     * @return  PublicKeyCredentialSource|null
+     * @return  PublicKeyCredentialSource
      *
      * @throws  \Exception
      * @since   4.2.0

plugins/webservices/users/src/Extension/Users.php

@@ -12,6 +12,7 @@
 
 use Joomla\CMS\Event\Application\BeforeApiRouteEvent;
 use Joomla\CMS\Plugin\CMSPlugin;
+use Joomla\CMS\Router\ApiRouter;
 use Joomla\Event\SubscriberInterface;
 
 // phpcs:disable PSR1.Files.SideEffects