Merge pull request #15029 from snipe/fixes/small_docblock_fixes

General cleanup - Docblock fixes, adding type hinting, added tests, added asset model form validator

app/Helpers/StorageHelper.php

@@ -3,10 +3,13 @@
 namespace App\Helpers;
 
 use Illuminate\Support\Facades\Storage;
-
+use Illuminate\Http\Response;
+use Illuminate\Http\RedirectResponse;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 class StorageHelper
 {
-    public static function downloader($filename, $disk = 'default')
+    public static function downloader($filename, $disk = 'default') : BinaryFileResponse | RedirectResponse | StreamedResponse
     {
         if ($disk == 'default') {
             $disk = config('filesystems.default');

app/Http/Controllers/Accessories/AccessoriesController.php

@@ -7,10 +7,10 @@
 use App\Http\Requests\ImageUploadRequest;
 use App\Models\Accessory;
 use App\Models\Company;
-use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Facades\Validator;
-use Redirect;
+use \Illuminate\Contracts\View\View;
+use \Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Log;
 
 /** This controller handles all actions related to Accessories for
@@ -27,24 +27,19 @@ class AccessoriesController extends Controller
      * @author [A. Gianotto] [<[email protected]>]
      * @see AccessoriesController::getDatatable() method that generates the JSON response
      * @since [v1.0]
-     * @return View
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function index()
+    public function index() : View
     {
         $this->authorize('index', Accessory::class);
-
         return view('accessories/index');
     }
 
     /**
      * Returns a view with a form to create a new Accessory.
      *
      * @author [A. Gianotto] [<[email protected]>]
-     * @return View
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function create()
+    public function create() : View
     {
         $this->authorize('create', Accessory::class);
         $category_type = 'accessory';
@@ -58,10 +53,8 @@ public function create()
      *
      * @author [A. Gianotto] [<[email protected]>]
      * @param ImageUploadRequest $request
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function store(ImageUploadRequest $request)
+    public function store(ImageUploadRequest $request) : RedirectResponse
     {
         $this->authorize(Accessory::class);
 
@@ -80,7 +73,7 @@ public function store(ImageUploadRequest $request)
         $accessory->purchase_date           = request('purchase_date');
         $accessory->purchase_cost           = request('purchase_cost');
         $accessory->qty                     = request('qty');
-        $accessory->user_id                 = Auth::user()->id;
+        $accessory->user_id                 = auth()->id();
         $accessory->supplier_id             = request('supplier_id');
         $accessory->notes                   = request('notes');
 
@@ -100,15 +93,12 @@ public function store(ImageUploadRequest $request)
      *
      * @author [A. Gianotto] [<[email protected]>]
      * @param  int $accessoryId
-     * @return View
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function edit($accessoryId = null)
+    public function edit($accessoryId = null) : View | RedirectResponse
     {
 
         if ($item = Accessory::find($accessoryId)) {
             $this->authorize($item);
-
             return view('accessories/edit', compact('item'))->with('category_type', 'accessory');
         }
 
@@ -122,9 +112,8 @@ public function edit($accessoryId = null)
      * @author [J. Vinsmoke]
      * @param int $accessoryId
      * @since [v6.0]
-     * @return View
      */
-    public function getClone($accessoryId = null)
+    public function getClone($accessoryId = null) : View | RedirectResponse
     {
 
         $this->authorize('create', Accessory::class);
@@ -151,10 +140,8 @@ public function getClone($accessoryId = null)
      * @author [A. Gianotto] [<[email protected]>]
      * @param ImageUploadRequest $request
      * @param  int $accessoryId
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function update(ImageUploadRequest $request, $accessoryId = null)
+    public function update(ImageUploadRequest $request, $accessoryId = null) : RedirectResponse
     {
         if ($accessory = Accessory::withCount('users as users_count')->find($accessoryId)) {
 
@@ -205,10 +192,8 @@ public function update(ImageUploadRequest $request, $accessoryId = null)
      *
      * @author [A. Gianotto] [<[email protected]>]
      * @param  int $accessoryId
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function destroy($accessoryId)
+    public function destroy($accessoryId) : RedirectResponse
     {
         if (is_null($accessory = Accessory::find($accessoryId))) {
             return redirect()->route('accessories.index')->with('error', trans('admin/accessories/message.not_found'));
@@ -243,10 +228,8 @@ public function destroy($accessoryId)
      * @param  int $accessoryID
      * @see AccessoriesController::getDataView() method that generates the JSON response
      * @since [v1.0]
-     * @return View
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function show($accessoryID = null)
+    public function show($accessoryID = null) : View | RedirectResponse
     {
         $accessory = Accessory::withCount('users as users_count')->find($accessoryID);
         $this->authorize('view', $accessory);

app/Http/Controllers/Accessories/AccessoriesFilesController.php

@@ -7,10 +7,11 @@
 use App\Http\Requests\UploadFileRequest;
 use App\Models\Actionlog;
 use App\Models\Accessory;
-use Illuminate\Support\Facades\Response;
 use Illuminate\Support\Facades\Storage;
-use Symfony\Accessory\HttpFoundation\JsonResponse;
 use Illuminate\Support\Facades\Log;
+use \Illuminate\Contracts\View\View;
+use \Illuminate\Http\RedirectResponse;
+use Illuminate\Support\Facades\Response;
 
 class AccessoriesFilesController extends Controller
 {
@@ -19,20 +20,17 @@ class AccessoriesFilesController extends Controller
      *
      * @param UploadFileRequest $request
      * @param int $accessoryId
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
-     *@author [A. Gianotto] [<[email protected]>]
+     * @author [A. Gianotto] [<[email protected]>]
      * @since [v1.0]
      * @todo Switch to using the AssetFileRequest form request validator.
      */
-    public function store(UploadFileRequest $request, $accessoryId = null)
+    public function store(UploadFileRequest $request, $accessoryId = null) : RedirectResponse
     {
 
         if (config('app.lock_passwords')) {
             return redirect()->route('accessories.show', ['accessory'=>$accessoryId])->with('error', trans('general.feature_disabled'));
         }
 
-
         $accessory = Accessory::find($accessoryId);
 
         if (isset($accessory->id)) {
@@ -69,10 +67,8 @@ public function store(UploadFileRequest $request, $accessoryId = null)
      * @since [v1.0]
      * @param int $accessoryId
      * @param int $fileId
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function destroy($accessoryId = null, $fileId = null)
+    public function destroy($accessoryId = null, $fileId = null) : RedirectResponse
     {
         $accessory = Accessory::find($accessoryId);
 
@@ -107,10 +103,8 @@ public function destroy($accessoryId = null, $fileId = null)
      * @since [v1.4]
      * @param int $accessoryId
      * @param int $fileId
-     * @return \Symfony\Accessory\HttpFoundation\Response
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function show($accessoryId = null, $fileId = null, $download = true)
+    public function show($accessoryId = null, $fileId = null, $download = true) : View | RedirectResponse | Response
     {
 
         Log::debug('Private filesystem is: '.config('filesystems.default'));

app/Http/Controllers/Accessories/AccessoryCheckinController.php

@@ -7,8 +7,9 @@
 use App\Models\Accessory;
 use App\Models\User;
 use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\DB;
+use \Illuminate\Contracts\View\View;
+use \Illuminate\Http\RedirectResponse;
 
 class AccessoryCheckinController extends Controller
 {
@@ -19,15 +20,10 @@ class AccessoryCheckinController extends Controller
      * @param Request $request
      * @param int $accessoryUserId
      * @param string $backto
-     * @return View
-     * @internal param int $accessoryId
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function create($accessoryUserId = null, $backto = null)
+    public function create($accessoryUserId = null, $backto = null) : View | RedirectResponse
     {
-        // Check if the accessory exists
         if (is_null($accessory_user = DB::table('accessories_users')->find($accessoryUserId))) {
-            // Redirect to the accessory management page with error
             return redirect()->route('accessories.index')->with('error', trans('admin/accessories/message.not_found'));
         }
 
@@ -44,15 +40,10 @@ public function create($accessoryUserId = null, $backto = null)
      * @author [A. Gianotto] [<[email protected]>]
      * @param null $accessoryUserId
      * @param string $backto
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
-     * @internal param int $accessoryId
      */
-    public function store(Request $request, $accessoryUserId = null, $backto = null)
+    public function store(Request $request, $accessoryUserId = null, $backto = null) : RedirectResponse
     {
-        // Check if the accessory exists
         if (is_null($accessory_user = DB::table('accessories_users')->find($accessoryUserId))) {
-            // Redirect to the accessory management page with error
             return redirect()->route('accessories.index')->with('error', trans('admin/accessories/message.does_not_exist'));
         }
 
@@ -70,7 +61,7 @@ public function store(Request $request, $accessoryUserId = null, $backto = null)
         if (DB::table('accessories_users')->where('id', '=', $accessory_user->id)->delete()) {
             $return_to = e($accessory_user->assigned_to);
 
-            event(new CheckoutableCheckedIn($accessory, User::find($return_to), Auth::user(), $request->input('note'), $checkin_at));
+            event(new CheckoutableCheckedIn($accessory, User::find($return_to), auth()->user(), $request->input('note'), $checkin_at));
 
             return redirect()->route('accessories.show', $accessory->id)->with('success', trans('admin/accessories/message.checkin.success'));
         }

app/Http/Controllers/Accessories/AccessoryCheckoutController.php

@@ -10,7 +10,8 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\DB;
-use Illuminate\Support\Facades\Input;
+use \Illuminate\Contracts\View\View;
+use \Illuminate\Http\RedirectResponse;
 
 class AccessoryCheckoutController extends Controller
 {
@@ -19,10 +20,8 @@ class AccessoryCheckoutController extends Controller
      *
      * @author [A. Gianotto] [<[email protected]>]
      * @param  int $id
-     * @return View
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function create($id)
+    public function create($id) : View | RedirectResponse
     {
 
         if ($accessory = Accessory::withCount('users as users_count')->find($id)) {
@@ -59,10 +58,8 @@ public function create($id)
      * @author [A. Gianotto] [<[email protected]>]
      * @param Request $request
      * @param  int $accessoryId
-     * @return \Illuminate\Http\RedirectResponse
-     * @throws \Illuminate\Auth\Access\AuthorizationException
      */
-    public function store(Request $request, $accessoryId)
+    public function store(Request $request, $accessoryId) : RedirectResponse
     {
         // Check if the accessory exists
         if (is_null($accessory = Accessory::withCount('users as users_count')->find($accessoryId))) {
@@ -95,7 +92,7 @@ public function store(Request $request, $accessoryId)
 
         DB::table('accessories_users')->where('assigned_to', '=', $accessory->assigned_to)->where('accessory_id', '=', $accessory->id)->first();
 
-        event(new CheckoutableCheckedOut($accessory, $user, Auth::user(), $request->input('note')));
+        event(new CheckoutableCheckedOut($accessory, $user, auth()->user(), $request->input('note')));
 
         // Redirect to the new accessory page
         return redirect()->route('accessories.index')->with('success', trans('admin/accessories/message.checkout.success'));

app/Http/Controllers/Account/AcceptanceController.php

@@ -28,30 +28,27 @@
 use App\Http\Controllers\SettingsController;
 use Barryvdh\DomPDF\Facade\Pdf;
 use Carbon\Carbon;
-use phpDocumentor\Reflection\Types\Compound;
+use \Illuminate\Contracts\View\View;
+use \Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Log;
 
 class AcceptanceController extends Controller
 {
     /**
      * Show a listing of pending checkout acceptances for the current user
-     *
-     * @return View
      */
-    public function index()
+    public function index() : View
     {
-        $acceptances = CheckoutAcceptance::forUser(Auth::user())->pending()->get();
-
+        $acceptances = CheckoutAcceptance::forUser(auth()->user())->pending()->get();
         return view('account/accept.index', compact('acceptances'));
     }
 
     /**
      * Shows a form to either accept or decline the checkout acceptance
      *
      * @param  int  $id
-     * @return mixed
      */
-    public function create($id)
+    public function create($id) : View | RedirectResponse
     {
         $acceptance = CheckoutAcceptance::find($id);
 
@@ -64,7 +61,7 @@ public function create($id)
             return redirect()->route('account.accept')->with('error', trans('admin/users/message.error.asset_already_accepted'));
         }
 
-        if (! $acceptance->isCheckedOutTo(Auth::user())) {
+        if (! $acceptance->isCheckedOutTo(auth()->user())) {
             return redirect()->route('account.accept')->with('error', trans('admin/users/message.error.incorrect_user_accepted'));
         }
 
@@ -80,9 +77,8 @@ public function create($id)
      *
      * @param  Request $request
      * @param  int  $id
-     * @return \Illuminate\Http\RedirectResponse
      */
-    public function store(Request $request, $id)
+    public function store(Request $request, $id) : RedirectResponse
     {
         $acceptance = CheckoutAcceptance::find($id);
 
@@ -94,7 +90,7 @@ public function store(Request $request, $id)
             return redirect()->route('account.accept')->with('error', trans('admin/users/message.error.asset_already_accepted'));
         }
 
-        if (! $acceptance->isCheckedOutTo(Auth::user())) {
+        if (! $acceptance->isCheckedOutTo(auth()->user())) {
             return redirect()->route('account.accept')->with('error', trans('admin/users/message.error.incorrect_user_accepted'));
         }