Make nullable parameters explicit.

Implicitly nullable parameters will be deprecated in PHP 8.4. This also fixes many cases where a doc comment didn't match reality.
EreMaijala · Sep 10, 2024 · a7e5e45 · a7e5e45
1 parent 7c7c9d0
commit a7e5e45
Show file tree

Hide file tree

Showing 761 changed files with 1,858 additions and 2,137 deletions.
diff --git a/module/VuFind/src/VuFind/Account/UserAccountServiceFactory.php b/module/VuFind/src/VuFind/Account/UserAccountServiceFactory.php
@@ -64,7 +64,7 @@ class UserAccountServiceFactory implements FactoryInterface
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if ($options !== null) {
             throw new \Exception('Unexpected options sent to factory!');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/AbstractBase.php b/module/VuFind/src/VuFind/AjaxHandler/AbstractBase.php
@@ -45,7 +45,7 @@ abstract class AbstractBase implements AjaxHandlerInterface
     /**
      * Session settings
      *
-     * @var SessionSettings
+     * @var ?SessionSettings
      */
     protected $sessionSettings = null;
 
@@ -69,7 +69,7 @@ protected function disableSessionWrites()
      * Format a response array.
      *
      * @param mixed $response Response data
-     * @param int   $httpCode HTTP status code (omit for default)
+     * @param ?int  $httpCode HTTP status code (omit for default)
      *
      * @return array
      */

diff --git a/module/VuFind/src/VuFind/AjaxHandler/AbstractIlsAndUserActionFactory.php b/module/VuFind/src/VuFind/AjaxHandler/AbstractIlsAndUserActionFactory.php
@@ -64,7 +64,7 @@ class AbstractIlsAndUserActionFactory implements \Laminas\ServiceManager\Factory
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         return new $requestedName(
             $container->get(\VuFind\Session\Settings::class),

diff --git a/module/VuFind/src/VuFind/AjaxHandler/AbstractRelaisActionFactory.php b/module/VuFind/src/VuFind/AjaxHandler/AbstractRelaisActionFactory.php
@@ -64,7 +64,7 @@ class AbstractRelaisActionFactory implements \Laminas\ServiceManager\Factory\Fac
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/CommentRecordFactory.php b/module/VuFind/src/VuFind/AjaxHandler/CommentRecordFactory.php
@@ -66,7 +66,7 @@ class CommentRecordFactory implements \Laminas\ServiceManager\Factory\FactoryInt
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/DeleteRecordCommentFactory.php b/module/VuFind/src/VuFind/AjaxHandler/DeleteRecordCommentFactory.php
@@ -64,7 +64,7 @@ class DeleteRecordCommentFactory implements \Laminas\ServiceManager\Factory\Fact
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/DoiLookup.php b/module/VuFind/src/VuFind/AjaxHandler/DoiLookup.php
@@ -85,7 +85,7 @@ class DoiLookup extends AbstractBase
     /**
      * View renderer
      *
-     * @var RendererInterface
+     * @var ?RendererInterface
      */
     protected $viewRenderer = null;
 

diff --git a/module/VuFind/src/VuFind/AjaxHandler/DoiLookupFactory.php b/module/VuFind/src/VuFind/AjaxHandler/DoiLookupFactory.php
@@ -64,7 +64,7 @@ class DoiLookupFactory implements \Laminas\ServiceManager\Factory\FactoryInterfa
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetACSuggestionsFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetACSuggestionsFactory.php
@@ -65,7 +65,7 @@ class GetACSuggestionsFactory implements
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetIlsStatusFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetIlsStatusFactory.php
@@ -64,7 +64,7 @@ class GetIlsStatusFactory implements \Laminas\ServiceManager\Factory\FactoryInte
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetItemStatuses.php b/module/VuFind/src/VuFind/AjaxHandler/GetItemStatuses.php
@@ -176,14 +176,14 @@ protected function pickValue($rawList, $mode, $msg, $transPrefix = false)
      * Based on settings and the number of callnumbers, return callnumber handler
      * Use callnumbers before pickValue is run.
      *
-     * @param array  $list           Array of callnumbers.
-     * @param string $displaySetting config.ini setting -- first, all or msg
+     * @param ?array  $list           Array of callnumbers.
+     * @param ?string $displaySetting config.ini setting -- first, all or msg
      *
      * @return string
      */
     protected function getCallnumberHandler($list = null, $displaySetting = null)
     {
-        if ($displaySetting == 'msg' && count($list) > 1) {
+        if ($displaySetting == 'msg' && count($list ?? []) > 1) {
             return false;
         }
         return $this->config->Item_Status->callnumber_handler ?? false;

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetItemStatusesFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetItemStatusesFactory.php
@@ -64,7 +64,7 @@ class GetItemStatusesFactory implements \Laminas\ServiceManager\Factory\FactoryI
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetRecordCommentsAsHTMLFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetRecordCommentsAsHTMLFactory.php
@@ -64,7 +64,7 @@ class GetRecordCommentsAsHTMLFactory implements \Laminas\ServiceManager\Factory\
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetRecordCoverFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetRecordCoverFactory.php
@@ -65,7 +65,7 @@ class GetRecordCoverFactory implements FactoryInterface
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         $config
             = $container->get(\VuFind\Config\PluginManager::class)->get('config');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetRecordDetailsFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetRecordDetailsFactory.php
@@ -64,7 +64,7 @@ class GetRecordDetailsFactory implements \Laminas\ServiceManager\Factory\Factory
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetRecordRatingFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetRecordRatingFactory.php
@@ -65,7 +65,7 @@ class GetRecordRatingFactory implements \Laminas\ServiceManager\Factory\FactoryI
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetRecordTagsFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetRecordTagsFactory.php
@@ -65,7 +65,7 @@ class GetRecordTagsFactory implements \Laminas\ServiceManager\Factory\FactoryInt
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetRecordVersionsFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetRecordVersionsFactory.php
@@ -64,7 +64,7 @@ class GetRecordVersionsFactory implements \Laminas\ServiceManager\Factory\Factor
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetResolverLinksFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetResolverLinksFactory.php
@@ -64,7 +64,7 @@ class GetResolverLinksFactory implements \Laminas\ServiceManager\Factory\Factory
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetResultCountFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetResultCountFactory.php
@@ -64,7 +64,7 @@ class GetResultCountFactory implements \Laminas\ServiceManager\Factory\FactoryIn
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetSaveStatusesFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetSaveStatusesFactory.php
@@ -66,7 +66,7 @@ class GetSaveStatusesFactory implements \Laminas\ServiceManager\Factory\FactoryI
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetSearchResultsFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetSearchResultsFactory.php
@@ -64,7 +64,7 @@ class GetSearchResultsFactory implements \Laminas\ServiceManager\Factory\Factory
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetSideFacetsFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetSideFacetsFactory.php
@@ -66,7 +66,7 @@ class GetSideFacetsFactory implements \Laminas\ServiceManager\Factory\FactoryInt
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetUserFinesFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetUserFinesFactory.php
@@ -65,7 +65,7 @@ class GetUserFinesFactory extends AbstractIlsAndUserActionFactory implements Fac
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetUserTransactions.php b/module/VuFind/src/VuFind/AjaxHandler/GetUserTransactions.php
@@ -47,7 +47,7 @@ class GetUserTransactions extends AbstractIlsAndUserAction
     /**
      * Paginator
      *
-     * @var \VuFind\ILS\PaginationHelper
+     * @var ?\VuFind\ILS\PaginationHelper
      */
     protected $paginationHelper = null;
 

diff --git a/module/VuFind/src/VuFind/AjaxHandler/GetVisDataFactory.php b/module/VuFind/src/VuFind/AjaxHandler/GetVisDataFactory.php
@@ -64,7 +64,7 @@ class GetVisDataFactory implements \Laminas\ServiceManager\Factory\FactoryInterf
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/KeepAliveFactory.php b/module/VuFind/src/VuFind/AjaxHandler/KeepAliveFactory.php
@@ -64,7 +64,7 @@ class KeepAliveFactory implements \Laminas\ServiceManager\Factory\FactoryInterfa
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/RecommendFactory.php b/module/VuFind/src/VuFind/AjaxHandler/RecommendFactory.php
@@ -65,7 +65,7 @@ class RecommendFactory implements \Laminas\ServiceManager\Factory\FactoryInterfa
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/SystemStatusFactory.php b/module/VuFind/src/VuFind/AjaxHandler/SystemStatusFactory.php
@@ -64,7 +64,7 @@ class SystemStatusFactory implements \Laminas\ServiceManager\Factory\FactoryInte
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/AjaxHandler/TagRecordFactory.php b/module/VuFind/src/VuFind/AjaxHandler/TagRecordFactory.php
@@ -64,7 +64,7 @@ class TagRecordFactory implements \Laminas\ServiceManager\Factory\FactoryInterfa
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options passed to factory.');

diff --git a/module/VuFind/src/VuFind/Auth/AbstractBase.php b/module/VuFind/src/VuFind/Auth/AbstractBase.php
@@ -69,7 +69,7 @@ abstract class AbstractBase implements
     /**
      * Configuration settings
      *
-     * @var \Laminas\Config\Config
+     * @var ?\Laminas\Config\Config
      */
     protected $config = null;
 

diff --git a/module/VuFind/src/VuFind/Auth/AlmaDatabase.php b/module/VuFind/src/VuFind/Auth/AlmaDatabase.php
@@ -48,14 +48,14 @@ class AlmaDatabase extends Database
     /**
      * Alma driver
      *
-     * @var \VuFind\ILS\Driver\Alma
+     * @var ?\VuFind\ILS\Driver\Alma
      */
     protected $almaDriver = null;
 
     /**
      * Alma config
      *
-     * @var array
+     * @var ?array
      */
     protected $almaConfig = null;
 

diff --git a/module/VuFind/src/VuFind/Auth/CASFactory.php b/module/VuFind/src/VuFind/Auth/CASFactory.php
@@ -62,7 +62,7 @@ class CASFactory implements \Laminas\ServiceManager\Factory\FactoryInterface
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options sent to factory.');

diff --git a/module/VuFind/src/VuFind/Auth/ChoiceAuthFactory.php b/module/VuFind/src/VuFind/Auth/ChoiceAuthFactory.php
@@ -62,7 +62,7 @@ class ChoiceAuthFactory implements \Laminas\ServiceManager\Factory\FactoryInterf
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options sent to factory.');

diff --git a/module/VuFind/src/VuFind/Auth/EmailAuthenticatorFactory.php b/module/VuFind/src/VuFind/Auth/EmailAuthenticatorFactory.php
@@ -62,7 +62,7 @@ class EmailAuthenticatorFactory implements \Laminas\ServiceManager\Factory\Facto
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options sent to factory.');

diff --git a/module/VuFind/src/VuFind/Auth/EmailFactory.php b/module/VuFind/src/VuFind/Auth/EmailFactory.php
@@ -62,7 +62,7 @@ class EmailFactory implements \Laminas\ServiceManager\Factory\FactoryInterface
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options sent to factory.');

diff --git a/module/VuFind/src/VuFind/Auth/FacebookFactory.php b/module/VuFind/src/VuFind/Auth/FacebookFactory.php
@@ -62,7 +62,7 @@ class FacebookFactory implements \Laminas\ServiceManager\Factory\FactoryInterfac
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
-        array $options = null
+        ?array $options = null
     ) {
         if (!empty($options)) {
             throw new \Exception('Unexpected options sent to factory.');

diff --git a/module/VuFind/src/VuFind/Auth/ILS.php b/module/VuFind/src/VuFind/Auth/ILS.php
@@ -53,7 +53,7 @@ class ILS extends AbstractBase
     /**
      * Catalog connection
      *
-     * @var \VuFind\ILS\Connection
+     * @var ?\VuFind\ILS\Connection
      */
     protected $catalog = null;
 

diff --git a/module/VuFind/src/VuFind/Auth/ILSAuthenticator.php b/module/VuFind/src/VuFind/Auth/ILSAuthenticator.php
@@ -63,7 +63,7 @@ class ILSAuthenticator implements DbServiceAwareInterface
     /**
      * Authentication manager
      *
-     * @var Manager
+     * @var ?Manager
      */
     protected $authManager = null;
 
@@ -77,14 +77,14 @@ class ILSAuthenticator implements DbServiceAwareInterface
     /**
      * Is encryption enabled?
      *
-     * @var bool
+     * @var ?bool
      */
     protected $encryptionEnabled = null;
 
     /**
      * Encryption key used for catalog passwords (null if encryption disabled):
      *
-     * @var string
+     * @var ?string
      */
     protected $encryptionKey = null;