fixes done by psalm

Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>

6 files changed, 53 insertions, 13 deletions

diff --git a/lib/Controller/ApiController.php b/lib/Controller/ApiController.php
index 1ffa1272d..a434f8de7 100644
--- a/lib/Controller/ApiController.php
+++ b/lib/Controller/ApiController.php
@@ -49,9 +49,9 @@ class ApiController extends BaseApiController
     }
 
     /**
-     * @return IUser
+     * @return IUser|null
      */
-    protected function getUser()
+    protected function getUser(): ?IUser
     {
         if ($this->userSession === null) {
             throw new NotLoggedInException();
diff --git a/lib/Controller/Controller.php b/lib/Controller/Controller.php
index 726ee8e7d..ab3c83a70 100644
--- a/lib/Controller/Controller.php
+++ b/lib/Controller/Controller.php
@@ -48,9 +48,9 @@ class Controller extends BaseController
     }
 
     /**
-     * @return IUser
+     * @return IUser|null
      */
-    protected function getUser()
+    protected function getUser(): ?IUser
     {
         if ($this->userSession === null) {
             throw new NotLoggedInException();
diff --git a/lib/Controller/FolderController.php b/lib/Controller/FolderController.php
index acf3f0109..9dc13b309 100644
--- a/lib/Controller/FolderController.php
+++ b/lib/Controller/FolderController.php
@@ -56,8 +56,12 @@ class FolderController extends Controller
 
     /**
      * @NoAdminRequired
+     *
+     * @return array[]
+     *
+     * @psalm-return array{folders: array}
      */
-    public function index()
+    public function index(): array
     {
         $folders = $this->folderService->findAllForUser($this->getUserId());
         return ['folders' => $this->serialize($folders)];
diff --git a/lib/Controller/ItemApiController.php b/lib/Controller/ItemApiController.php
index 442734127..c958324af 100644
--- a/lib/Controller/ItemApiController.php
+++ b/lib/Controller/ItemApiController.php
@@ -109,6 +109,11 @@ class ItemApiController extends ApiController
     }
 
 
+    /**
+     * @return JSONResponse|array
+     *
+     * @psalm-return JSONResponse|array<empty, empty>
+     */
     private function setRead(bool $isRead, int $itemId)
     {
         try {
@@ -151,6 +156,11 @@ class ItemApiController extends ApiController
     }
 
 
+    /**
+     * @return JSONResponse|array
+     *
+     * @psalm-return JSONResponse|array<empty, empty>
+     */
     private function setStarred(bool $isStarred, int $feedId, string $guidHash)
     {
         try {
@@ -202,18 +212,22 @@ class ItemApiController extends ApiController
 
     /**
      * @NoAdminRequired
+     *
      * @NoCSRFRequired
+     *
      * @CORS
      *
      * @param int $newestItemId
+     *
+     * @return void
      */
-    public function readAll(int $newestItemId)
+    public function readAll(int $newestItemId): void
     {
         $this->oldItemService->readAll($newestItemId, $this->getUserId());
     }
 
 
-    private function setMultipleRead(bool $isRead, array $items)
+    private function setMultipleRead(bool $isRead, array $items): void
     {
         foreach ($items as $id) {
             try {
@@ -227,12 +241,16 @@ class ItemApiController extends ApiController
 
     /**
      * @NoAdminRequired
+     *
      * @NoCSRFRequired
+     *
      * @CORS
      *
      * @param int[] $items item ids
+     *
+     * @return void
      */
-    public function readMultiple(array $items)
+    public function readMultiple(array $items): void
     {
         $this->setMultipleRead(true, $items);
     }
@@ -240,12 +258,16 @@ class ItemApiController extends ApiController
 
     /**
      * @NoAdminRequired
+     *
      * @NoCSRFRequired
+     *
      * @CORS
      *
      * @param int[] $items item ids
+     *
+     * @return void
      */
-    public function unreadMultiple(array $items)
+    public function unreadMultiple(array $items): void
     {
         $this->setMultipleRead(false, $items);
     }
@@ -254,8 +276,10 @@ class ItemApiController extends ApiController
     /**
      * @param bool  $isStarred
      * @param array $items
+     *
+     * @return void
      */
-    private function setMultipleStarred(bool $isStarred, array $items)
+    private function setMultipleStarred(bool $isStarred, array $items): void
     {
         foreach ($items as $item) {
             try {
@@ -274,12 +298,16 @@ class ItemApiController extends ApiController
 
     /**
      * @NoAdminRequired
+     *
      * @NoCSRFRequired
+     *
      * @CORS
      *
      * @param int[] $items item ids
+     *
+     * @return void
      */
-    public function starMultiple(array $items)
+    public function starMultiple(array $items): void
     {
         $this->setMultipleStarred(true, $items);
     }
@@ -287,12 +315,16 @@ class ItemApiController extends ApiController
 
     /**
      * @NoAdminRequired
+     *
      * @NoCSRFRequired
+     *
      * @CORS
      *
      * @param array $items item ids
+     *
+     * @return void
      */
-    public function unstarMultiple(array $items)
+    public function unstarMultiple(array $items): void
     {
         $this->setMultipleStarred(false, $items);
     }
diff --git a/lib/Controller/ItemController.php b/lib/Controller/ItemController.php
index 8783a5286..96ebcbaec 100644
--- a/lib/Controller/ItemController.php
+++ b/lib/Controller/ItemController.php
@@ -249,8 +249,10 @@ class ItemController extends Controller
      * @NoAdminRequired
      *
      * @param int[] $itemIds item ids
+     *
+     * @return void
      */
-    public function readMultiple($itemIds)
+    public function readMultiple($itemIds): void
     {
         foreach ($itemIds as $id) {
             try {
diff --git a/lib/Controller/PageController.php b/lib/Controller/PageController.php
index 4b39ba9c2..35924d10c 100644
--- a/lib/Controller/PageController.php
+++ b/lib/Controller/PageController.php
@@ -189,6 +189,8 @@ class PageController extends Controller
      * @NoAdminRequired
      *
      * @param string $lang
+     *
+     * @return Http\JSONResponse|array
      */
     public function explore(string $lang)
     {