Simplify return type of \VuFind\Controller\AbstractBase::getUser() (#…

…3768)
vufind-org · Jun 13, 2024 · 9488393 · 9488393
1 parent 17888e6
commit 9488393
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 12 deletions.
diff --git a/module/VuFind/src/VuFind/Controller/AbstractBase.php b/module/VuFind/src/VuFind/Controller/AbstractBase.php
@@ -37,6 +37,7 @@
 use Laminas\Uri\Http;
 use Laminas\View\Model\ViewModel;
 use VuFind\Controller\Feature\AccessPermissionInterface;
+use VuFind\Db\Entity\UserEntityInterface;
 use VuFind\Exception\Auth as AuthException;
 use VuFind\Exception\ILS as ILSException;
 use VuFind\Http\PhpEnvironment\Request as HttpRequest;
@@ -316,11 +317,11 @@ protected function getILSAuthenticator()
     /**
      * Get the user object if logged in, false otherwise.
      *
-     * @return \VuFind\Db\Row\User|bool
+     * @return ?UserEntityInterface
      */
-    protected function getUser()
+    protected function getUser(): ?UserEntityInterface
     {
-        return $this->getAuthManager()->getUserObject() ?? false;
+        return $this->getAuthManager()->getUserObject();
     }
 
     /**

diff --git a/module/VuFind/src/VuFind/Controller/AbstractSearch.php b/module/VuFind/src/VuFind/Controller/AbstractSearch.php
@@ -523,8 +523,8 @@ protected function getRedirectForRecord(
     protected function retrieveSearchSecurely($searchId)
     {
         $sessId = $this->serviceLocator->get(SessionManager::class)->getId();
-        $user = $this->getUser() ?: null;
-        return $this->getDbService(SearchServiceInterface::class)->getSearchByIdAndOwner($searchId, $sessId, $user);
+        return $this->getDbService(SearchServiceInterface::class)
+            ->getSearchByIdAndOwner($searchId, $sessId, $this->getUser());
     }
 
     /**
@@ -536,12 +536,11 @@ protected function retrieveSearchSecurely($searchId)
      */
     protected function saveSearchToHistory($results)
     {
-        $user = $this->getUser() ?: null;
         $sessId = $this->serviceLocator->get(SessionManager::class)->getId();
         $this->serviceLocator->get(\VuFind\Search\SearchNormalizer::class)->saveNormalizedSearch(
             $results,
             $sessId,
-            $user?->getId()
+            $this->getUser()?->getId()
         );
     }
 

diff --git a/module/VuFind/src/VuFind/Controller/FeedbackController.php b/module/VuFind/src/VuFind/Controller/FeedbackController.php
@@ -65,7 +65,7 @@ public function formAction()
             $formId = 'FeedbackSite';
         }
 
-        $user = $this->getUser() ?: null;
+        $user = $this->getUser();
 
         $form = $this->serviceLocator->get($this->formClass);
         $prefill = $this->params()->fromQuery();

diff --git a/module/VuFind/src/VuFind/Controller/MyResearchController.php b/module/VuFind/src/VuFind/Controller/MyResearchController.php
@@ -1338,7 +1338,7 @@ public function deletelistAction()
         if ($confirm) {
             try {
                 $list = $this->getDbService(UserListServiceInterface::class)->getUserListById($listID);
-                $this->serviceLocator->get(FavoritesService::class)->destroyList($list, $this->getUser() ?: null);
+                $this->serviceLocator->get(FavoritesService::class)->destroyList($list, $this->getUser());
 
                 // Success Message
                 $this->flashMessenger()->addMessage('fav_list_delete', 'success');

diff --git a/module/VuFind/src/VuFind/Controller/SearchController.php b/module/VuFind/src/VuFind/Controller/SearchController.php
@@ -34,7 +34,6 @@
 
 use function array_slice;
 use function count;
-use function is_object;
 
 /**
  * Redirects the user to the appropriate default VuFind action.
@@ -195,7 +194,7 @@ public function historyAction()
                 ? $this->redirect()->toRoute('search-history')
                 : $this->forceLogin();
         }
-        $userId = is_object($user) ? $user->id : null;
+        $userId = $user?->getId();
 
         $searchHistoryHelper = $this->serviceLocator
             ->get(\VuFind\Search\History::class);
@@ -216,7 +215,7 @@ public function historyAction()
             unset($viewData['schedule']);
         } else {
             $viewData['scheduleOptions'] = $scheduleOptions;
-            $viewData['alertemail'] = is_object($user) ? $user->email : null;
+            $viewData['alertemail'] = $user?->getEmail();
         }
         return $this->createViewModel($viewData);
     }