Add return types to "safe" functions (#3011)

PHP type annotations improve static analysis because static analysis
tools can make stronger guarantees about types further down the AST.
These type hints are immensely useful for developers using PHP-specific
IDEs such as myself. This PR adds type annotations to many functions
throughout the codebase where the return type is immediately clear from
a brief inspection of the implementation. In addition to clearing
nuisance warnings in my IDE, PHPStan analysis is improved as can be seen
from some of the more specific errors changed in the PHPStan baseline.

Author: williamjallen

app/Console/Commands/AutoRemoveBuilds.php

@@ -37,7 +37,7 @@ public function __construct()
     /**
      * Execute the console command.
      */
-    public function handle()
+    public function handle(): void
     {
         set_time_limit(0);
 

app/Console/Commands/CheckKey.php

@@ -31,7 +31,7 @@ public function __construct()
         parent::__construct();
     }
 
-    public function handle()
+    public function handle(): int
     {
         if (trim(config('app.key')) === '') {
             echo 'Error: APP_KEY environment variable is not set.  You can use the following randomly generated key:' . PHP_EOL;

app/Console/Commands/MakeStorageDirectories.php

@@ -22,10 +22,8 @@ class MakeStorageDirectories extends Command
 
     /**
      * Execute the console command.
-     *
-     * @return int
      */
-    public function handle()
+    public function handle(): int
     {
         $storage_path = storage_path();
         $dirs_to_check = [

app/Console/Commands/PurgeUnusedProjects.php

@@ -33,10 +33,8 @@ public function __construct()
 
     /**
      * Execute the console command.
-     *
-     * @return void
      */
-    public function handle()
+    public function handle(): void
     {
         foreach (Project::doesntHave('builds')->get() as $project) {
             echo 'Deleting project: ' . $project->name . PHP_EOL;

app/Console/Commands/QueueSubmissions.php

@@ -37,7 +37,7 @@ public function __construct()
     /**
      * Execute the console command.
      */
-    public function handle()
+    public function handle(): void
     {
         // Queue the "build metadata" JSON files first, so they have a chance
         // to get parsed before the subsequent payload files.
@@ -57,7 +57,7 @@ public function handle()
         }
     }
 
-    private function queueFile($inboxFile)
+    private function queueFile($inboxFile): void
     {
         $filename = str_replace('inbox/', '', $inboxFile);
         $pos = strpos($filename, '_-_');

app/Console/Commands/RemoveUser.php

@@ -34,7 +34,7 @@ public function __construct()
     /**
      * Execute the console command.
      */
-    public function handle()
+    public function handle(): void
     {
         $email = $this->option('email');
         if (is_null($email)) {

app/Console/Commands/SaveUser.php

@@ -34,7 +34,7 @@ public function __construct()
     /**
      * Create or update a user.
      */
-    public function handle()
+    public function handle(): void
     {
         $email = $this->option('email');
         if (is_null($email)) {

app/Http/Controllers/BuildController.php

@@ -47,13 +47,13 @@ public function targets(int $build_id): View
     }
 
     // Render the build configure page.
-    public function configure($build_id = null)
+    public function configure($build_id = null): View
     {
         return $this->renderBuildPage($build_id, 'configure');
     }
 
     // Render the build notes page.
-    public function notes($build_id = null)
+    public function notes($build_id = null): View
     {
         $this->setBuildById($build_id);
 
@@ -63,7 +63,7 @@ public function notes($build_id = null)
     }
 
     // Render the build summary page.
-    public function summary($build_id = null)
+    public function summary($build_id = null): View
     {
         return $this->renderBuildPage($build_id, 'summary', 'Build Summary');
     }
@@ -85,7 +85,7 @@ public function tests(int $build_id): View
         ]);
     }
 
-    protected function renderBuildPage(int $build_id, string $page_name, string $page_title = '')
+    protected function renderBuildPage(int $build_id, string $page_name, string $page_title = ''): View
     {
         $this->setBuildById($build_id);
         if ($page_title === '') {

app/Http/Controllers/CDash.php

@@ -108,10 +108,8 @@ protected function getRequestContents()
     /**
      * Returns JSON responses for CDash API requests or regular response given an
      * un-decodable json response
-     *
-     * @return ResponseFactory|JsonResponse|Response|\Symfony\Component\HttpFoundation\Response
      */
-    protected function handleApiRequest()
+    protected function handleApiRequest(): Response|JsonResponse|\Symfony\Component\HttpFoundation\Response|ResponseFactory
     {
         $json = $this->getRequestContents();
         $status = http_response_code(); // this should be empty if not previously set

app/Http/Controllers/EditProjectController.php

@@ -3,19 +3,20 @@
 namespace App\Http\Controllers;
 
 use Illuminate\Support\Facades\Gate;
+use Illuminate\View\View;
 
 final class EditProjectController extends AbstractProjectController
 {
     // Render the create project form.
-    public function create()
+    public function create(): View
     {
         Gate::authorize('create-project');
 
         return $this->vue('edit-project', 'Create Project', ['projectid' => 0], false);
     }
 
     // Render the edit project form.
-    public function edit($project_id)
+    public function edit($project_id): View
     {
         $this->setProjectById((int) $project_id);
         Gate::authorize('edit-project', $this->project);