manual: Cleanup controllers a bit

Author: sander-bol

app/src/Application/ApplicationController.php

@@ -135,18 +135,12 @@ public function notAllowed(): void
         ]);
     }
 
-    /**
-     * @return EventApi
-     */
-    private function getEventApi()
+    private function getEventApi(): EventApi
     {
         return $this->application->container->get(EventApi::class);
     }
 
-    /**
-     * @return ContactApi
-     */
-    private function getContactApi()
+    private function getContactApi(): ContactApi
     {
         return $this->application->container->get(ContactApi::class);
     }

app/src/Application/BaseApi.php

@@ -78,7 +78,7 @@ private function makeHttpCall(string $httpMethod, string $url, string $content =
 
     protected function apiGet(string $url, array $params = []): string
     {
-        $paramsString = count($params) > 0 ? '?' . http_build_query($params, '', '&') : '';
+        $paramsString = $params !== [] ? '?' . http_build_query($params, '', '&') : '';
 
         return $this->makeHttpCall('GET', $url . $paramsString)->get_body();
     }
@@ -89,7 +89,7 @@ protected function apiGet(string $url, array $params = []): string
      */
     protected function apiDelete(string $url, array $params = []): array
     {
-        $paramsString = count($params) > 0 ? '?' . http_build_query($params, '', '&') : '';
+        $paramsString = $params !== [] ? '?' . http_build_query($params, '', '&') : '';
         $baseApiResult = $this->makeHttpCall('DELETE', $url . $paramsString);
         return [$baseApiResult->get_status_code(), $baseApiResult->get_body(), $baseApiResult->get_headers()];
     }

app/src/Application/BaseDb.php

@@ -3,10 +3,9 @@
 
 abstract class BaseDb
 {
-    protected \Application\CacheService $cache;
+    protected CacheService $cache;
 
-    /** @var string */
-    protected $keyName;
+    protected string $keyName;
 
     public function __construct(CacheService $cacheService)
     {

app/src/Event/EventController.php

@@ -202,7 +202,7 @@ public function eventDefault(string $friendly_name)
         return $this->$action($friendly_name);
     }
 
-    public function details(string $friendly_name)
+    public function details(string $friendly_name): void
     {
         $eventApi = $this->getEventApi();
         $event    = $eventApi->getByFriendlyUrl($friendly_name);
@@ -227,7 +227,7 @@ public function details(string $friendly_name)
         );
     }
 
-    public function attendees(string $friendly_name)
+    public function attendees(string $friendly_name): void
     {
         $eventApi = $this->getEventApi();
         $event    = $eventApi->getByFriendlyUrl($friendly_name);
@@ -249,7 +249,7 @@ public function attendees(string $friendly_name)
         );
     }
 
-    public function comments(string $friendly_name)
+    public function comments(string $friendly_name): void
     {
         $eventApi = $this->getEventApi();
         $event    = $eventApi->getByFriendlyUrl($friendly_name);
@@ -1102,7 +1102,7 @@ public function addHost(string $friendly_name): void
         );
     }
 
-    private function appoveClaimPendingTalk($talkApi, $claim, array $data): void
+    private function appoveClaimPendingTalk(\Talk\TalkApi $talkApi, $claim, array $data): void
     {
         $talkApi->claimTalk($claim->approve_claim_uri, $data);
 
@@ -1112,7 +1112,7 @@ private function appoveClaimPendingTalk($talkApi, $claim, array $data): void
     /**
      * Reject a talk claim
      */
-    private function rejectClaimPendingTalk($talkApi, $claim, array $data): void
+    private function rejectClaimPendingTalk(\Talk\TalkApi $talkApi, $claim, array $data): void
     {
         $talkApi->rejectTalkClaim($claim->approve_claim_uri, $data);
 
@@ -1122,7 +1122,7 @@ private function rejectClaimPendingTalk($talkApi, $claim, array $data): void
     /**
      * Add a talk to the event
      */
-    public function addTalk(string $friendly_name)
+    public function addTalk(string $friendly_name): void
     {
         $eventApi = $this->getEventApi();
         $event    = $eventApi->getByFriendlyUrl($friendly_name);
@@ -1200,7 +1200,7 @@ public function addTalk(string $friendly_name)
     /**
      * Edit tracks for this event
      */
-    public function editTracks(string $friendly_name)
+    public function editTracks(string $friendly_name): void
     {
         $eventApi = $this->getEventApi();
         $event    = $eventApi->getByFriendlyUrl($friendly_name);
@@ -1400,34 +1400,22 @@ private function getTalkSlugsFromApi(EventEntity $eventEntity): array
         return $slugs;
     }
 
-    /**
-     * @return CacheService
-     */
-    private function getCache()
+    private function getCache(): CacheService
     {
         return $this->application->container->get(CacheService::class);
     }
 
-    /**
-     * @return TalkDb
-     */
-    private function getTalkDb()
+    private function getTalkDb(): TalkDb
     {
         return $this->application->container->get(TalkDb::class);
     }
 
-    /**
-     * @return TalkApi
-     */
-    private function getTalkApi()
+    private function getTalkApi(): TalkApi
     {
         return $this->application->container->get(TalkApi::class);
     }
 
-    /**
-     * @return UserApi
-     */
-    private function getUserApi()
+    private function getUserApi(): UserApi
     {
         return $this->application->container->get(UserApi::class);
     }

app/src/Search/SearchController.php

@@ -2,13 +2,9 @@
 namespace Search;
 
 use Application\BaseController;
-use Application\CacheService;
 use Event\EventApi;
-use Event\EventDb;
 use Slim\Slim;
 use Talk\TalkApi;
-use Talk\TalkDb;
-use User\UserDb;
 use User\UserApi;
 
 /**
@@ -197,26 +193,17 @@ private function searchUsersByKeyword($page, string $keyword): array
         return $this->getUserApi()->getCollection($apiQueryParams);
     }
 
-    /**
-     * @return EventApi
-     */
-    protected function getEventApi()
+    protected function getEventApi(): EventApi
     {
         return $this->application->container->get(EventApi::class);
     }
 
-    /**
-     * @return TalkApi
-     */
-    protected function getTalkApi()
+    protected function getTalkApi(): TalkApi
     {
         return $this->application->container->get(TalkApi::class);
     }
 
-    /**
-     * @return UserApi
-     */
-    private function getUserApi()
+    private function getUserApi(): UserApi
     {
         return $this->application->container->get(UserApi::class);
     }

app/src/Talk/TalkApi.php

@@ -54,13 +54,8 @@ public function getCollection($talks_uri, array $queryParams = []): array
         return $collectionData;
     }
 
-    /**
-     * @param integer $talkId
-     * @return TalkEntity|null
-     */
-    public function getTalkByTalkId($talkId)
+    public function getTalkByTalkId(int $talkId): ?\Talk\TalkEntity
     {
-        $talkId = (int)$talkId;
         if ($talkId === 0) {
             return null;
         }
@@ -92,9 +87,8 @@ public function getTalkBySlug($talkSlug, $eventUri)
      *
      * @param string $talk_uri  API talk uri
      * @param bool $verbose  Return verbose data?
-     * @return TalkEntity|false
      */
-    public function getTalk(string $talk_uri, $verbose = false)
+    public function getTalk(string $talk_uri, bool $verbose = false): ?TalkEntity
     {
         if ($verbose) {
             $talk_uri .= '?verbose=yes';
@@ -103,7 +97,7 @@ public function getTalk(string $talk_uri, $verbose = false)
         $collection = (array)json_decode($this->apiGet($talk_uri));
 
         if (!isset($collection['talks'])) {
-            return false;
+            return null;
         }
 
         $talkEntity = new TalkEntity($collection['talks'][0]);
@@ -121,10 +115,10 @@ public function getTalk(string $talk_uri, $verbose = false)
     /**
      * Get Comments for given talk
      *
-     * @param bool $verbose
+     *
      * @return TalkCommentEntity[]
      */
-    public function getComments(string $comment_uri, $verbose = false, $limitTo = null): array
+    public function getComments(string $comment_uri, bool $verbose = false, $limitTo = null): array
     {
         $params = [];
         if ($verbose) {
@@ -146,34 +140,27 @@ public function getComments(string $comment_uri, $verbose = false, $limitTo = nu
         return $commentData;
     }
 
-    /**
-     * Add a comment
-     *
-     * @param TalkEntity $talk
-     * @param int $rating
-     * @param string $comment
-     */
-    public function addComment($talk, $rating, $comment): bool
+    public function addComment(TalkEntity $talkEntity, int $rating, string $comment): bool
     {
-        $uri    = $talk->getCommentsUri();
+        $uri    = $talkEntity->getCommentsUri();
         $params = [
             'rating'  => $rating,
             'comment' => $comment,
         ];
         [$status, $result] = $this->apiPost($uri, $params);
 
-        if ($status == 201) {
+        if ($status === 201) {
             return true;
         }
 
         throw new Exception("Failed to add comment: " . $result);
     }
 
-    public function reportComment($uri): bool
+    public function reportComment(string $uri): bool
     {
         [$status, $result] = $this->apiPost($uri);
 
-        if ($status == 202) {
+        if ($status === 202) {
             return true;
         }
 
@@ -189,12 +176,12 @@ public function toggleStar($talk)
     {
         if ($talk->getStarred()) {
             [$status, $result] = $this->apiDelete($talk->getStarredUri(), []);
-            if ($status == 200) {
+            if ($status === 200) {
                 return ['starred' => false];
             }
         } else {
             [$status, $result] = $this->apiPost($talk->getStarredUri(), []);
-            if ($status == 201) {
+            if ($status === 201) {
                 return ['starred' => true];
             }
         }
@@ -233,10 +220,9 @@ public function getAgenda(string $talksUri): array
     /**
      * Add a talk to an event
      *
-     * @param string $talksUri
      * @param array $data
      */
-    public function addTalk($talksUri, $data)
+    public function addTalk(string $talksUri, $data)
     {
         array_walk($data, function (&$value): void {
             if ($value instanceof \DateTimeInterface) {
@@ -281,10 +267,9 @@ public function addTalk($talksUri, $data)
     /**
      * Edit a talk
      *
-     * @param string $talkUri
      * @param array $data
      */
-    public function editTalk($talkUri, $data)
+    public function editTalk(string $talkUri, $data)
     {
         array_walk($data, function (&$value): void {
             if ($value instanceof \DateTimeInterface) {
@@ -324,7 +309,7 @@ public function editTalk($talkUri, $data)
         throw new \RuntimeException($result);
     }
 
-    public function claimTalk($talkSpeakersUri, $data): bool
+    public function claimTalk(string $talkSpeakersUri, $data): bool
     {
         [$status, $result, $headers] = $this->apiPost($talkSpeakersUri, $data);
 
@@ -355,10 +340,9 @@ public function rejectTalkClaim(string $talkSpeakersUri, $data): bool
     /**
      * Add a talk to a track
      *
-     * @param string $talkTracksUri
      * @param string $trackUri
      */
-    public function addTalkToTrack($talkTracksUri, $trackUri): bool
+    public function addTalkToTrack(string $talkTracksUri, $trackUri): bool
     {
         $params = [
             'track_uri' => $trackUri,