Applied Rector + cleanups

app/src/Apikey/ApikeyApi.php

@@ -7,10 +7,8 @@ class ApikeyApi extends BaseApi
 {
     /**
      * Get all tokens associated with the current user
-     *
-     * @return array
      */
-    public function getCollection($queryParams)
+    public function getCollection($queryParams): array
     {
         $token_uri = $this->baseApiUrl . '/v2.1/token';
 
@@ -33,10 +31,8 @@ public function getCollection($queryParams)
 
     /**
      * Get a specified API-key associated with the current user
-     *
-     * @return ApikeyEntity
      */
-    public function getById($id, $queryParams = ['verbose' => 'yes'])
+    public function getById($id, $queryParams = ['verbose' => 'yes']): \Apikey\ApikeyEntity
     {
         $tokens_uri = $this->baseApiUrl . '/v2.1/token/' . urlencode($id);
 
@@ -53,12 +49,9 @@ public function getById($id, $queryParams = ['verbose' => 'yes'])
     }
 
     /**
-     * @param string $tokenUri
-     *
      * @throws \Exception
-     * @return bool
      */
-    public function deleteClient($tokenUri)
+    public function deleteClient(string $tokenUri): bool
     {
         [$status, $result, $headers] = $this->apiDelete($tokenUri);
 
@@ -67,6 +60,7 @@ public function deleteClient($tokenUri)
             if (is_array($decoded)) {
                 $result = current($decoded);
             }
+
             throw new \Exception($result);
         }
 

app/src/Apikey/ApikeyController.php

@@ -13,16 +13,16 @@ class ApikeyController extends BaseController
     /**
      * @var int number of results per pagination page
      */
-    private $resultsPerPage = 10;
+    private int $resultsPerPage = 10;
 
-    protected function defineRoutes(Slim $app)
+    protected function defineRoutes(Slim $slim): void
     {
-        $app->get('/user/:username/apikey', [$this, 'index'])->name('apikey-show');
-        $app->get('/user/:username/apikey/:apikey/delete', [$this, 'deleteApiKey'])->via('GET', 'POST')
+        $slim->get('/user/:username/apikey', [$this, 'index'])->name('apikey-show');
+        $slim->get('/user/:username/apikey/:apikey/delete', [$this, 'deleteApiKey'])->via('GET', 'POST')
                                                                                    ->name('apikey-delete');
     }
 
-    public function index($username)
+    public function index($username): void
     {
         $thisUrl = $this->application->urlFor('apikey-show', ['username' => $username]);
 
@@ -65,8 +65,8 @@ public function index($username)
         // save page position in case user returns
         $_SESSION['api_key_page'] = $page;
 
-        $tokenApi = $this->getApikeyApi();
-        $tokens   = $tokenApi->getCollection($queryParams);
+        $apikeyApi = $this->getApikeyApi();
+        $tokens    = $apikeyApi->getCollection($queryParams);
 
         // reset session state if oauth_access_tokens are removed while user is logged in (found during testing)
         if (!isset($tokens['tokens'])) {
@@ -105,7 +105,7 @@ public function index($username)
         );
     }
 
-    public function deleteApiKey($username, $apikey)
+    public function deleteApiKey($username, $apikey): void
     {
         $thisUrl = $this->application->urlFor('apikey-delete', ['apikey' => $apikey, 'username' => $username]);
 
@@ -124,7 +124,7 @@ public function deleteApiKey($username, $apikey)
         $apikeyApi = $this->getApikeyApi();
         try {
             $apikey = $apikeyApi->getById($apikey);
-        } catch (Exception $e) {
+        } catch (Exception $exception) {
             $this->application->notFound();
             return;
         }
@@ -156,9 +156,9 @@ public function deleteApiKey($username, $apikey)
                         $this->application->urlFor('apikey-show', ['username' => $username])
                     );
                     return;
-                } catch (\RuntimeException $e) {
+                } catch (\RuntimeException $exception) {
                     $form->adderror(
-                        new FormError('An error occurred while removing this API-Key: ' . $e->getmessage())
+                        new FormError('An error occurred while removing this API-Key: ' . $exception->getmessage())
                     );
                 }
             }
@@ -175,10 +175,7 @@ public function deleteApiKey($username, $apikey)
         );
     }
 
-    /**
-     * @return ApikeyApi
-     */
-    private function getApikeyApi()
+    private function getApikeyApi(): \Apikey\ApikeyApi
     {
         return new ApikeyApi($this->cfg, $this->accessToken);
     }

app/src/Apikey/ApikeyDeleteFormType.php

@@ -17,22 +17,17 @@ class ApikeyDeleteFormType extends AbstractType
      *
      * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return 'apikeydelete';
     }
 
     /**
      * Adds fields with their types and validation constraints to this definition.
-     *
-     * @param FormBuilderInterface $builder
-     * @param array                $options
-     *
-     * @return void
      */
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $formBuilder, array $options): void
     {
-        $builder
+        $formBuilder
             ->add(
                 'apikey_id',
                 'hidden',

app/src/Apikey/ApikeyEntity.php

@@ -7,7 +7,7 @@
 
 class ApikeyEntity extends BaseEntity
 {
-    public function getId()
+    public function getId(): string
     {
         return substr($this->data->token_uri, strrpos($this->data->token_uri, '/') + 1);
     }
@@ -17,12 +17,12 @@ public function getApplicationName()
         return $this->data->application;
     }
 
-    public function getLastUsedDateTime()
+    public function getLastUsedDateTime(): \DateTimeImmutable
     {
         return new \DateTimeImmutable($this->data->last_used_date);
     }
 
-    public function getCreationDateTime()
+    public function getCreationDateTime(): \DateTimeImmutable
     {
         return new \DateTimeImmutable($this->data->created_date);
     }

app/src/Application/ApplicationController.php

@@ -3,25 +3,28 @@
 
 use Event\EventDb;
 use Event\EventApi;
+use Slim\Slim;
+use Symfony\Component\Form\FormFactoryInterface;
 use User\UserDb;
 use User\UserApi;
 
 class ApplicationController extends BaseController
 {
-    protected function defineRoutes(\Slim\Slim $app)
+    protected function defineRoutes(Slim $slim): void
     {
-        $app->get('/', [$this, 'index']);
-        $app->get('/about', [$this, 'about'])->name('about');
-        $app->map('/contact', [$this, 'contact'])->via('GET', 'POST')->name('contact');
-        $app->get('/not-allowed', [$this, 'notAllowed'])->name('not-allowed');
-        $app->get('/assets', [$this, 'assets'])->name('assets');
+        $slim->get('/', [$this, 'index']);
+        $slim->get('/about', [$this, 'about'])->name('about');
+        $slim->map('/contact', [$this, 'contact'])->via('GET', 'POST')->name('contact');
+        $slim->get('/not-allowed', [$this, 'notAllowed'])->name('not-allowed');
+        $slim->get('/assets', [$this, 'assets'])->name('assets');
     }
 
-    public function index()
+    public function index(): void
     {
-        $page = ((int)$this->application->request()->get('page') === 0)
-            ? 1
-            : $this->application->request()->get('page');
+        $page = (int)$this->application->request()->get('page', 1);
+        if ($page === 0) {
+            $page = 1;
+        }
 
         $perPage = 10;
         $start   = ($page -1) * $perPage;
@@ -42,21 +45,16 @@ public function index()
 
     /**
      * Get latest current events
-     *
-     * @param int $start
-     * @param int $perPage
-     * @return array
      */
-    public function getCurrentEvents($start, $perPage)
+    public function getCurrentEvents(int $start, int $perPage): array
     {
-        $eventApi = $this->getEventApi();
-        return $eventApi->getEvents($perPage, $start, 'upcoming');
+        return $this->getEventApi()->getEvents($perPage, $start, 'upcoming');
     }
 
     /**
      * Render the about page
      */
-    public function about()
+    public function about(): void
     {
         $this->render(
             'Application/about.html.twig',
@@ -69,7 +67,7 @@ public function about()
     /**
      * Render the contact page
      */
-    public function contact()
+    public function contact(): void
     {
         $request = $this->application->request();
 
@@ -116,7 +114,7 @@ public function contact()
     /**
      * Render the assets page
      */
-    public function assets()
+    public function assets(): void
     {
         $this->render(
             'Application/assets.html.twig',
@@ -130,25 +128,19 @@ public function assets()
     /**
      * Render the notAllowed page
      */
-    public function notAllowed()
+    public function notAllowed(): void
     {
         $this->render('Application/not-allowed.html.twig', [
             'redirect' => $this->application->request->get('redirect')
         ]);
     }
 
-    /**
-     * @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);
     }