Switched to methods on the base controller to quiet Codacy

snipe · snipe · commit ae8e700948ec · 2026-07-29T05:21:30.000+01:00
diff --git a/app/Http/Controllers/Api/UploadedFilesController.php b/app/Http/Controllers/Api/UploadedFilesController.php
@@ -31,7 +31,7 @@ public function index(Request $request, $object_type, $id): JsonResponse|array
     {
 
         // Check the permissions to make sure the user can view the object
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('files', $object);
 
         if (! $object) {
@@ -49,7 +49,7 @@ public function index(Request $request, $object_type, $id): JsonResponse|array
                 'created_at',
             ];
 
-        $uploads = parent::$map_object_type[$object_type]::withTrashed()->find($id)->uploads()
+        $uploads = parent::getMapObjectType()[$object_type]::withTrashed()->find($id)->uploads()
             ->with('adminuser');
 
         $limit = app('api_limit_value');
@@ -97,29 +97,29 @@ public function store(UploadFileRequest $request, $object_type, $id): JsonRespon
         // to the object. `manageFiles` is stricter than `files` (used by
         // index/show below) so a read-only cascade like the one on
         // AssetModelPolicy does not accidentally grant write access.
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('manageFiles', $object);
 
         if (! $object) {
             return response()->json(Helper::formatStandardApiResponse('error', null, trans('general.file_upload_status.invalid_object')));
         }
 
         // If the file storage directory doesn't exist, create it
-        if (! Storage::exists(parent::$map_storage_path[$object_type])) {
-            Storage::makeDirectory(parent::$map_storage_path[$object_type], 775);
+        if (! Storage::exists(parent::getMapStoragePath()[$object_type])) {
+            Storage::makeDirectory(parent::getMapStoragePath()[$object_type], 775);
         }
 
         if ($request->hasFile('file')) {
             // Loop over the attached files and add them to the object
             foreach ($request->file('file') as $file) {
-                $file_name = $request->handleFile(parent::$map_storage_path[$object_type], parent::$map_file_prefix[$object_type].'-'.$object->id, $file);
+                $file_name = $request->handleFile(parent::getMapStoragePath()[$object_type], parent::getMapFilePrefix()[$object_type].'-'.$object->id, $file);
                 $files[] = $file_name;
                 $object->logUpload($file_name, $request->input('notes'));
             }
 
             if (isset($files)) {
                 $file_results = Actionlog::select('action_logs.*')->where('action_type', '=', 'uploaded')
-                    ->where('item_type', '=', parent::$map_object_type[$object_type])
+                    ->where('item_type', '=', parent::getMapObjectType()[$object_type])
                     ->where('item_id', '=', $id)->whereIn('filename', $files)
                     ->get();
 
@@ -147,25 +147,25 @@ public function store(UploadFileRequest $request, $object_type, $id): JsonRespon
     public function show($object_type, $id, $file_id): JsonResponse|StreamedResponse|Storage|StorageHelper|BinaryFileResponse
     {
         // Check the permissions to make sure the user can view the object
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('files', $object);
 
         if (! $object) {
             return response()->json(Helper::formatStandardApiResponse('error', null, trans('general.file_upload_status.invalid_object')));
         }
 
         // Check that the file being requested exists for the object
-        if (! $log = Actionlog::whereNotNull('filename')->where('item_type', parent::$map_object_type[$object_type])->where('item_id', $object->id)->find($file_id)
+        if (! $log = Actionlog::whereNotNull('filename')->where('item_type', parent::getMapObjectType()[$object_type])->where('item_id', $object->id)->find($file_id)
         ) {
             return response()->json(Helper::formatStandardApiResponse('error', null, trans('general.file_upload_status.invalid_id')), 200);
         }
 
-        if (! Storage::exists(parent::$map_storage_path[$object_type].$log->filename)) {
+        if (! Storage::exists(parent::getMapStoragePath()[$object_type].$log->filename)) {
             return response()->json(Helper::formatStandardApiResponse('error', null, trans('general.file_upload_status.file_not_found'), 200));
         }
 
         if (request('inline') == 'true') {
-            $path = parent::$map_storage_path[$object_type];
+            $path = parent::getMapStoragePath()[$object_type];
 
             // Only allowlisted extensions may be served inline. Everything
             // else (including XML, which can pull an XSLT stylesheet and
@@ -180,7 +180,7 @@ public function show($object_type, $id, $file_id): JsonResponse|StreamedResponse
             ]);
         }
 
-        return StorageHelper::downloader(parent::$map_storage_path[$object_type].$log->filename);
+        return StorageHelper::downloader(parent::getMapStoragePath()[$object_type].$log->filename);
 
     }
 
@@ -201,7 +201,7 @@ public function destroy($object_type, $id, $file_id): JsonResponse
 
         // See store(): `manageFiles` is the strict write ability so a
         // read-only cascade in files() does not authorize deletion.
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('manageFiles', $object);
 
         if (! $object) {
@@ -212,14 +212,14 @@ public function destroy($object_type, $id, $file_id): JsonResponse
         $log = Actionlog::query()
             ->where('id', $file_id)
             ->where('action_type', 'uploaded')
-            ->where('item_type', parent::$map_object_type[$object_type])
+            ->where('item_type', parent::getMapObjectType()[$object_type])
             ->where('item_id', $object->id)
             ->first();
 
         if ($log) {
             // Check the file actually exists, and delete it
-            if (Storage::exists(parent::$map_storage_path[$object_type].$log->filename)) {
-                Storage::delete(parent::$map_storage_path[$object_type].$log->filename);
+            if (Storage::exists(parent::getMapStoragePath()[$object_type].$log->filename)) {
+                Storage::delete(parent::getMapStoragePath()[$object_type].$log->filename);
             }
             // Delete the record of the file
             if ($log->logUploadDelete($object, $log->filename)) {
diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php
@@ -102,4 +102,32 @@ public function __construct()
         view()->share('signedIn', Auth::check());
         view()->share('user', auth()->user());
     }
+
+    /**
+     * Accessor for the object-type map. The public static array above is
+     * kept for back-compat with any external callers that reach into it
+     * directly, but internal callers should prefer this getter so static
+     * analyzers (Codacy) don't misparse `parent::$map_object_type` as a
+     * variable-variable dereference.
+     */
+    public static function getMapObjectType(): array
+    {
+        return static::$map_object_type;
+    }
+
+    /**
+     * Accessor for the storage-path map. See getMapObjectType for rationale.
+     */
+    public static function getMapStoragePath(): array
+    {
+        return static::$map_storage_path;
+    }
+
+    /**
+     * Accessor for the file-prefix map. See getMapObjectType for rationale.
+     */
+    public static function getMapFilePrefix(): array
+    {
+        return static::$map_file_prefix;
+    }
 }
diff --git a/app/Http/Controllers/MaintenancesController.php b/app/Http/Controllers/MaintenancesController.php
@@ -299,7 +299,7 @@ private function storeUploadedFiles(ImageUploadRequest $request, Maintenance $ma
         }
 
         $objectType = 'maintenances';
-        $storagePath = parent::$map_storage_path[$objectType];
+        $storagePath = parent::getMapStoragePath()[$objectType];
 
         if (! Storage::exists($storagePath)) {
             Storage::makeDirectory($storagePath, 775);
@@ -314,7 +314,7 @@ private function storeUploadedFiles(ImageUploadRequest $request, Maintenance $ma
 
             $fileName = $uploadFileRequest->handleFile(
                 $storagePath,
-                parent::$map_file_prefix[$objectType].'-'.$maintenance->id,
+                parent::getMapFilePrefix()[$objectType].'-'.$maintenance->id,
                 $file
             );
 
diff --git a/app/Http/Controllers/QrCodeController.php b/app/Http/Controllers/QrCodeController.php
@@ -35,7 +35,7 @@ public function show($object_type, $id): Response|BinaryFileResponse|string|bool
             return $object_type.' is not a valid type.';
         }
 
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
 
         if (! $object) {
             return 'That item is invalid';
diff --git a/app/Http/Controllers/UploadedFilesController.php b/app/Http/Controllers/UploadedFilesController.php
@@ -39,28 +39,28 @@ public function store(UploadFileRequest $request, $object_type, $id): RedirectRe
         // to the object. `manageFiles` is stricter than `files` (used by
         // show/download) so a read-only cascade like the one on
         // AssetModelPolicy does not accidentally grant write access.
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('manageFiles', $object);
 
         if (! $object) {
             return redirect()->back()->withFragment('files')->with('error', trans('general.file_upload_status.invalid_object'));
         }
 
         // If the file storage directory doesn't exist, create it
-        if (! Storage::exists(parent::$map_storage_path[$object_type])) {
-            Storage::makeDirectory(parent::$map_storage_path[$object_type], 775);
+        if (! Storage::exists(parent::getMapStoragePath()[$object_type])) {
+            Storage::makeDirectory(parent::getMapStoragePath()[$object_type], 775);
         }
 
         if ($request->hasFile('file')) {
             // Loop over the attached files and add them to the object
             foreach ($request->file('file') as $file) {
-                $file_name = $request->handleFile(parent::$map_storage_path[$object_type], parent::$map_file_prefix[$object_type].'-'.$object->id, $file);
+                $file_name = $request->handleFile(parent::getMapStoragePath()[$object_type], parent::getMapFilePrefix()[$object_type].'-'.$object->id, $file);
                 $files[] = $file_name;
                 $object->logUpload($file_name, $request->input('notes'));
             }
 
             $files = Actionlog::select('action_logs.*')->where('action_type', '=', 'uploaded')
-                ->where('item_type', '=', parent::$map_object_type[$object_type])
+                ->where('item_type', '=', parent::getMapObjectType()[$object_type])
                 ->where('item_id', '=', $id)->whereIn('filename', $files)
                 ->get();
 
@@ -87,24 +87,24 @@ public function store(UploadFileRequest $request, $object_type, $id): RedirectRe
     public function show($object_type, $id, $file_id): RedirectResponse|StreamedResponse|Storage|StorageHelper|BinaryFileResponse
     {
         // Check the permissions to make sure the user can view the object
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('files', $object);
 
         if (! $object) {
             return redirect()->back()->withFragment('files')->with('error', trans('general.file_upload_status.invalid_object'));
         }
 
         // Check that the file being requested exists for the object
-        if (! $log = Actionlog::whereNotNull('filename')->where('item_type', parent::$map_object_type[$object_type])->where('item_id', $object->id)->find($file_id)) {
+        if (! $log = Actionlog::whereNotNull('filename')->where('item_type', parent::getMapObjectType()[$object_type])->where('item_id', $object->id)->find($file_id)) {
             return redirect()->back()->withFragment('files')->with('error', trans('general.file_upload_status.invalid_id'));
         }
 
-        if (! Storage::exists(parent::$map_storage_path[$object_type].$log->filename)) {
+        if (! Storage::exists(parent::getMapStoragePath()[$object_type].$log->filename)) {
             return redirect()->back()->withFragment('files')->with('error', trans('general.file_upload_status.file_not_found'));
         }
 
         if (request('inline') == 'true') {
-            $path = parent::$map_storage_path[$object_type];
+            $path = parent::getMapStoragePath()[$object_type];
 
             if (! StorageHelper::allowSafeInline($path.$log->filename)) {
                 return StorageHelper::downloader($path.$log->filename);
@@ -113,7 +113,7 @@ public function show($object_type, $id, $file_id): RedirectResponse|StreamedResp
             return Storage::download($path.$log->filename, $log->filename, ['Content-Disposition' => 'inline']);
         }
 
-        return StorageHelper::downloader(parent::$map_storage_path[$object_type].$log->filename);
+        return StorageHelper::downloader(parent::getMapStoragePath()[$object_type].$log->filename);
 
     }
 
@@ -134,21 +134,21 @@ public function destroy($object_type, $id, $file_id): RedirectResponse
 
         // See store(): `manageFiles` is the strict write ability so a
         // read-only cascade in files() does not authorize deletion.
-        $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);
+        $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);
         $this->authorize('manageFiles', $object);
 
         if (! $object) {
             return redirect()->back()->withFragment('files')->with('error', trans('general.file_upload_status.invalid_object'));
         }
 
         // Check for the file
-        $log = Actionlog::where('id', $file_id)->where('item_type', parent::$map_object_type[$object_type])
+        $log = Actionlog::where('id', $file_id)->where('item_type', parent::getMapObjectType()[$object_type])
             ->where('item_id', $object->id)->first();
 
         if ($log) {
             // Check the file actually exists, and delete it
-            if (Storage::exists(parent::$map_storage_path[$object_type].$log->filename)) {
-                Storage::delete(parent::$map_storage_path[$object_type].$log->filename);
+            if (Storage::exists(parent::getMapStoragePath()[$object_type].$log->filename)) {
+                Storage::delete(parent::getMapStoragePath()[$object_type].$log->filename);
             }
             // Delete the record of the file
             if ($log->logUploadDelete($object, $log->filename)) {

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function show($object_type, $id): Response\|BinaryFileResponse\|string\|bool`
`35`	`35`	`return $object_type.' is not a valid type.';`
`36`	`36`	`}`
`37`	`37`
`38`		`- $object = parent::$map_object_type[$object_type]::withTrashed()->find($id);`
	`38`	`+ $object = parent::getMapObjectType()[$object_type]::withTrashed()->find($id);`
`39`	`39`
`40`	`40`	`if (! $object) {`
`41`	`41`	`return 'That item is invalid';`