Mark controllers as "final" (#1587)

Our controller inheritance hierarchy currently has two types of controllers: "abstract" controllers which provide useful helper functions, and "business" controllers which contain functions which are called by Laravel's routing system. We should never inherit from a "business" controller, since there should never be a need to inherit the business logic contained within. At the same time, an easy mistake to make is to inherit from `BuildController` rather than `AbstractBuildController` for example. To help enforce this, we can mark each "business" controller with the `final` keyword and use PHPStan to ensure that no controllers inherit from a "business" controller. Co-authored-by: Joseph Snyder <joe.snyder@kitware.com>
Kitware · Aug 2, 2023 · 412430c · 412430c
1 parent 623c08d
commit 412430c
Show file tree

Hide file tree

Showing 28 changed files with 28 additions and 28 deletions.
diff --git a/app/Http/Controllers/AdminController.php b/app/Http/Controllers/AdminController.php
@@ -21,7 +21,7 @@
 require_once 'include/version.php';
 require_once 'include/upgrade_functions.php';
 
-class AdminController extends AbstractController
+final class AdminController extends AbstractController
 {
  public function import(): View
  {

diff --git a/app/Http/Controllers/AuthTokenController.php b/app/Http/Controllers/AuthTokenController.php
@@ -12,7 +12,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Illuminate\Http\Request;
 
-class AuthTokenController extends AbstractController
+final class AuthTokenController extends AbstractController
 {
  public function manage(): View
  {

diff --git a/app/Http/Controllers/BuildController.php b/app/Http/Controllers/BuildController.php
@@ -28,7 +28,7 @@
 
 require_once('include/repository.php');
 
-class BuildController extends AbstractBuildController
+final class BuildController extends AbstractBuildController
 {
  // Render the build configure page.
  public function configure($build_id = null)

diff --git a/app/Http/Controllers/BuildPropertiesController.php b/app/Http/Controllers/BuildPropertiesController.php
@@ -13,7 +13,7 @@
 
 require_once 'include/filterdataFunctions.php';
 
-class BuildPropertiesController extends AbstractBuildController
+final class BuildPropertiesController extends AbstractBuildController
 {
  public function buildProperties(): View
  {

diff --git a/app/Http/Controllers/CDash.php b/app/Http/Controllers/CDash.php
@@ -15,7 +15,7 @@
  * Class CDash
  * @package App\Http\Controllers
  */
-class CDash extends AbstractController
+final class CDash extends AbstractController
 {
  /** @var Request $request */
  private $request;

diff --git a/app/Http/Controllers/CTestConfigurationController.php b/app/Http/Controllers/CTestConfigurationController.php
@@ -4,7 +4,7 @@
 use CDash\Model\SubProject;
 use Illuminate\Http\Response;
 
-class CTestConfigurationController extends AbstractProjectController
+final class CTestConfigurationController extends AbstractProjectController
 {
  public function get(int $id): Response
  {

diff --git a/app/Http/Controllers/CoverageController.php b/app/Http/Controllers/CoverageController.php
@@ -25,7 +25,7 @@
 
 require_once 'include/filterdataFunctions.php';
 
-class CoverageController extends AbstractBuildController
+final class CoverageController extends AbstractBuildController
 {
  public function compareCoverage(): Response|RedirectResponse
  {

diff --git a/app/Http/Controllers/EditProjectController.php b/app/Http/Controllers/EditProjectController.php
@@ -3,7 +3,7 @@
 
 use Illuminate\Support\Facades\Gate;
 
-class EditProjectController extends AbstractProjectController
+final class EditProjectController extends AbstractProjectController
 {
  // Render the create project form.
  public function create()

diff --git a/app/Http/Controllers/ImageController.php b/app/Http/Controllers/ImageController.php
@@ -7,7 +7,7 @@
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
-class ImageController extends AbstractController
+final class ImageController extends AbstractController
 {
  /**
  * @throws HttpException

diff --git a/app/Http/Controllers/IndexController.php b/app/Http/Controllers/IndexController.php
@@ -4,7 +4,7 @@
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Response;
 
-class IndexController extends AbstractController
+final class IndexController extends AbstractController
 {
  public function showIndexPage(): Response|RedirectResponse
  {

diff --git a/app/Http/Controllers/ManageBannerController.php b/app/Http/Controllers/ManageBannerController.php
@@ -10,7 +10,7 @@
 use Illuminate\Support\Facades\Gate;
 use Illuminate\View\View;
 
-class ManageBannerController extends AbstractController
+final class ManageBannerController extends AbstractController
 {
  /**
  * TODO: (williamjallen) this function contains legacy XSL templating and should be converted

diff --git a/app/Http/Controllers/ManageMeasurementsController.php b/app/Http/Controllers/ManageMeasurementsController.php
@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Facades\Gate;
 
-class ManageMeasurementsController extends AbstractProjectController
+final class ManageMeasurementsController extends AbstractProjectController
 {
  // Render the 'manage measurements' page.
  public function show($project_id)

diff --git a/app/Http/Controllers/ManageProjectRolesController.php b/app/Http/Controllers/ManageProjectRolesController.php
@@ -12,7 +12,7 @@
 use Illuminate\View\View;
 use RuntimeException;
 
-class ManageProjectRolesController extends AbstractProjectController
+final class ManageProjectRolesController extends AbstractProjectController
 {
  /**
  * TODO: (williamjallen) this function contains legacy XSL templating and should be converted

diff --git a/app/Http/Controllers/ManageUsersController.php b/app/Http/Controllers/ManageUsersController.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\DB;
 use Illuminate\View\View;
 
-class ManageUsersController extends AbstractController
+final class ManageUsersController extends AbstractController
 {
  /**
  * TODO: (williamjallen) this function contains legacy XSL templating and should be converted

diff --git a/app/Http/Controllers/MapController.php b/app/Http/Controllers/MapController.php
@@ -6,7 +6,7 @@
 use Illuminate\Http\RedirectResponse;
 use Illuminate\View\View;
 
-class MapController extends AbstractProjectController
+final class MapController extends AbstractProjectController
 {
  public function viewMap(): View|RedirectResponse
  {

diff --git a/app/Http/Controllers/MonitorController.php b/app/Http/Controllers/MonitorController.php
@@ -13,7 +13,7 @@
 use Illuminate\Support\Facades\DB;
 use Illuminate\View\View;
 
-class MonitorController extends AbstractController
+final class MonitorController extends AbstractController
 {
  public function monitor(): View
  {

diff --git a/app/Http/Controllers/OAuthController.php b/app/Http/Controllers/OAuthController.php
@@ -14,7 +14,7 @@
  * Class OAuthController
  * @package App\Http\Controllers
  */
-class OAuthController extends AbstractController
+final class OAuthController extends AbstractController
 {
  /**
  * @param Request $request

diff --git a/app/Http/Controllers/ProjectController.php b/app/Http/Controllers/ProjectController.php
@@ -14,7 +14,7 @@
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Gate;
 
-class ProjectController extends AbstractProjectController
+final class ProjectController extends AbstractProjectController
 {
  public function apiCreateProject(): JsonResponse
  {

diff --git a/app/Http/Controllers/SiteController.php b/app/Http/Controllers/SiteController.php
@@ -12,7 +12,7 @@
 use Illuminate\Support\Facades\Gate;
 use Illuminate\View\View;
 
-class SiteController extends AbstractController
+final class SiteController extends AbstractController
 {
  public function siteStatistics(): View|RedirectResponse
  {

diff --git a/app/Http/Controllers/SubProjectController.php b/app/Http/Controllers/SubProjectController.php
@@ -11,7 +11,7 @@
 use Illuminate\Http\Response;
 use Illuminate\View\View;
 
-class SubProjectController extends AbstractProjectController
+final class SubProjectController extends AbstractProjectController
 {
  public function viewSubProjects(): Response
  {

diff --git a/app/Http/Controllers/SubmissionController.php b/app/Http/Controllers/SubmissionController.php
@@ -19,7 +19,7 @@
 use Illuminate\Support\Str;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
-class SubmissionController extends AbstractProjectController
+final class SubmissionController extends AbstractProjectController
 {
  public function submit(): Response|JsonResponse
  {

diff --git a/app/Http/Controllers/SubscribeProjectController.php b/app/Http/Controllers/SubscribeProjectController.php
@@ -11,7 +11,7 @@
 use Illuminate\Support\Facades\Auth;
 use Illuminate\View\View;
 
-class SubscribeProjectController extends AbstractProjectController
+final class SubscribeProjectController extends AbstractProjectController
 {
  /**
  * TODO: (williamjallen) this function contains legacy XSL templating and should be converted

diff --git a/app/Http/Controllers/TestController.php b/app/Http/Controllers/TestController.php
@@ -12,7 +12,7 @@
 
 include_once 'include/repository.php';
 
-class TestController extends AbstractProjectController
+final class TestController extends AbstractProjectController
 {
  // Render the test details page.
  public function details($buildtest_id = null)

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
@@ -20,7 +20,7 @@
 
 require_once 'include/cdashmail.php';
 
-class UserController extends AbstractController
+final class UserController extends AbstractController
 {
  public function userPage(): View
  {

diff --git a/app/Http/Controllers/UserNoteController.php b/app/Http/Controllers/UserNoteController.php
@@ -5,7 +5,7 @@
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Auth;
 
-class UserNoteController extends AbstractBuildController
+final class UserNoteController extends AbstractBuildController
 {
  public function apiAddUserNote(): JsonResponse
  {

diff --git a/app/Http/Controllers/UserStatisticsController.php b/app/Http/Controllers/UserStatisticsController.php
@@ -5,7 +5,7 @@
 use App\Services\PageTimer;
 use Illuminate\Http\JsonResponse;
 
-class UserStatisticsController extends AbstractProjectController
+final class UserStatisticsController extends AbstractProjectController
 {
  public function api(): JsonResponse
  {

diff --git a/app/Http/Controllers/ViewProjectsController.php b/app/Http/Controllers/ViewProjectsController.php
@@ -9,7 +9,7 @@
 use Illuminate\Support\Facades\DB;
 use Illuminate\View\View;
 
-class ViewProjectsController extends AbstractController
+final class ViewProjectsController extends AbstractController
 {
  public function viewAllProjects(): View|RedirectResponse
  {

diff --git a/app/Http/Controllers/ViewTestController.php b/app/Http/Controllers/ViewTestController.php
@@ -8,7 +8,7 @@
 
 require_once 'include/api_common.php';
 
-class ViewTestController extends AbstractController
+final class ViewTestController extends AbstractController
 {
  public function viewTest(): View
  {