A free open source IT asset/license management system
Refactor qty adjustment to trait
snipe3c7fe91c8651
diff --git a/app/Http/Controllers/Accessories/AccessoriesController.php b/app/Http/Controllers/Accessories/AccessoriesController.phpindex 1907ec4520..d861d867c1 100755--- a/app/Http/Controllers/Accessories/AccessoriesController.php+++ b/app/Http/Controllers/Accessories/AccessoriesController.php@@ -6,10 +6,9 @@ use App\Helpers\Helper;use App\Http\Controllers\Controller;use App\Http\Requests\AdjustQuantityRequest;use App\Http\Requests\ImageUploadRequest;-use App\Http\Requests\UploadFileRequest;+use App\Http\Traits\HandlesAdjustQuantity;use App\Models\Accessory;use App\Models\Company;-use DomainException;use Illuminate\Contracts\View\View;use Illuminate\Http\RedirectResponse;use Illuminate\Support\Facades\Storage;@@ -21,6 +20,8 @@ use Illuminate\Support\Facades\Storage;*/class AccessoriesController extends Controller{+ use HandlesAdjustQuantity;+/*** Returns a view that invokes the ajax tables which actually contains* the content for the accessories listing, which is generated in getDatatable.@@ -252,35 +253,16 @@ class AccessoriesController extends Controller}/**- * Apply an on-hand quantity delta (+/-) and log the change.- * Direction + amount from the form are converted to a signed delta- * for the AdjustsQuantity trait. Below-zero attempts surface as a- * flash error rather than a 500.+ * Apply an on-hand quantity delta (+/-) and log the change. The+ * shared body lives on the HandlesAdjustQuantity trait; this method+ * only owns the redirect-response shape.*/public function adjustQuantity(AdjustQuantityRequest $request, Accessory $accessory): RedirectResponse{- $this->authorize('update', $accessory);-- $filename = null;- if ($request->hasFile('file')) {- $filename = app(UploadFileRequest::class)->handleFile(- parent::getMapStoragePath()['accessories'],- parent::getMapFilePrefix()['accessories'].'-'.$accessory->id,- $request->file('file'),- );- }-- try {- $accessory->adjustQuantity(- (int) $request->input('amount'),- $request->input('note'),- $request->input('order_number'),- $filename,- );- } catch (DomainException) {- return redirect()->back()->with('error', trans('general.adjust_quantity_below_zero'));- }+ $error = $this->runAdjustQuantity($request, $accessory, 'accessories');- return redirect()->back()->with('success', trans('general.adjust_quantity_success'));+ return $error+ ? redirect()->back()->with('error', $error)+ : redirect()->back()->with('success', trans('general.adjust_quantity_success'));}}diff --git a/app/Http/Controllers/Api/AccessoriesController.php b/app/Http/Controllers/Api/AccessoriesController.phpindex 6ed6f226a7..b1a8585bb5 100644--- a/app/Http/Controllers/Api/AccessoriesController.php+++ b/app/Http/Controllers/Api/AccessoriesController.php@@ -9,8 +9,8 @@ use App\Http\Requests\AccessoryCheckoutRequest;use App\Http\Requests\AdjustQuantityRequest;use App\Http\Requests\ImageUploadRequest;use App\Http\Requests\StoreAccessoryRequest;-use App\Http\Requests\UploadFileRequest;use App\Http\Traits\CheckInOutTrait;+use App\Http\Traits\HandlesAdjustQuantity;use App\Http\Transformers\AccessoriesTransformer;use App\Http\Transformers\ActionlogsTransformer;use App\Http\Transformers\SelectlistTransformer;@@ -29,6 +29,7 @@ use Illuminate\Support\Facades\DB;class AccessoriesController extends Controller{use CheckInOutTrait;+ use HandlesAdjustQuantity;/*** Display a listing of the resource.@@ -324,27 +325,11 @@ class AccessoriesController extends Controller*/public function adjustQuantity(AdjustQuantityRequest $request, Accessory $accessory): JsonResponse{- $this->authorize('update', $accessory);-- $filename = null;- if ($request->hasFile('file')) {- $filename = app(UploadFileRequest::class)->handleFile(- parent::getMapStoragePath()['accessories'],- parent::getMapFilePrefix()['accessories'].'-'.$accessory->id,- $request->file('file'),- );- }+ $error = $this->runAdjustQuantity($request, $accessory, 'accessories');- try {- $accessory->adjustQuantity(- (int) $request->input('amount'),- $request->input('note'),- $request->input('order_number'),- $filename,- );- } catch (DomainException) {+ if ($error !== null) {return response()->json(- Helper::formatStandardApiResponse('error', null, trans('general.adjust_quantity_below_zero')),+ Helper::formatStandardApiResponse('error', null, $error),422,);}diff --git a/app/Http/Controllers/Api/ComponentsController.php b/app/Http/Controllers/Api/ComponentsController.phpindex 457011bec8..a01e9ff27e 100644--- a/app/Http/Controllers/Api/ComponentsController.php+++ b/app/Http/Controllers/Api/ComponentsController.php@@ -8,7 +8,7 @@ use App\Helpers\Helper;use App\Http\Controllers\Controller;use App\Http\Requests\AdjustQuantityRequest;use App\Http\Requests\ImageUploadRequest;-use App\Http\Requests\UploadFileRequest;+use App\Http\Traits\HandlesAdjustQuantity;use App\Http\Transformers\ActionlogsTransformer;use App\Http\Transformers\ComponentsTransformer;use App\Models\Asset;@@ -26,6 +26,8 @@ use Illuminate\Support\Facades\Validator;class ComponentsController extends Controller{+ use HandlesAdjustQuantity;+/*** Display a listing of the resource.*@@ -258,27 +260,11 @@ class ComponentsController extends Controller*/public function adjustQuantity(AdjustQuantityRequest $request, Component $component): JsonResponse{- $this->authorize('update', $component);-- $filename = null;- if ($request->hasFile('file')) {- $filename = app(UploadFileRequest::class)->handleFile(- parent::getMapStoragePath()['components'],- parent::getMapFilePrefix()['components'].'-'.$component->id,- $request->file('file'),- );- }+ $error = $this->runAdjustQuantity($request, $component, 'components');- try {- $component->adjustQuantity(- (int) $request->input('amount'),- $request->input('note'),- $request->input('order_number'),- $filename,- );- } catch (DomainException) {+ if ($error !== null) {return response()->json(- Helper::formatStandardApiResponse('error', null, trans('general.adjust_quantity_below_zero')),+ Helper::formatStandardApiResponse('error', null, $error),422,);}diff --git a/app/Http/Controllers/Api/ConsumablesController.php b/app/Http/Controllers/Api/ConsumablesController.phpindex a03d6966c9..a1f2fcf608 100644--- a/app/Http/Controllers/Api/ConsumablesController.php+++ b/app/Http/Controllers/Api/ConsumablesController.php@@ -9,7 +9,7 @@ use App\Http\Requests\AdjustQuantityRequest;use App\Http\Requests\FilterRequest;use App\Http\Requests\ImageUploadRequest;use App\Http\Requests\StoreConsumableRequest;-use App\Http\Requests\UploadFileRequest;+use App\Http\Traits\HandlesAdjustQuantity;use App\Http\Transformers\ActionlogsTransformer;use App\Http\Transformers\ConsumablesTransformer;use App\Http\Transformers\SelectlistTransformer;@@ -24,6 +24,8 @@ use Illuminate\Support\Facades\DB;class ConsumablesController extends Controller{+ use HandlesAdjustQuantity;+/*** Display a listing of the resource.*@@ -246,27 +248,11 @@ class ConsumablesController extends Controller*/public function adjustQuantity(AdjustQuantityRequest $request, Consumable $consumable): JsonResponse{- $this->authorize('update', $consumable);-- $filename = null;- if ($request->hasFile('file')) {- $filename = app(UploadFileRequest::class)->handleFile(- parent::getMapStoragePath()['consumables'],- parent::getMapFilePrefix()['consumables'].'-'.$consumable->id,- $request->file('file'),- );- }+ $error = $this->runAdjustQuantity($request, $consumable, 'consumables');- try {- $consumable->adjustQuantity(- (int) $request->input('amount'),- $request->input('note'),- $request->input('order_number'),- $filename,- );- } catch (DomainException) {+ if ($error !== null) {return response()->json(- Helper::formatStandardApiResponse('error', null, trans('general.adjust_quantity_below_zero')),+ Helper::formatStandardApiResponse('error', null, $error),422,);}diff --git a/app/Http/Controllers/Components/ComponentsController.php b/app/Http/Controllers/Components/ComponentsController.phpindex 3538233813..11dd821828 100644--- a/app/Http/Controllers/Components/ComponentsController.php+++ b/app/Http/Controllers/Components/ComponentsController.php@@ -7,10 +7,9 @@ use App\Http\Controllers\Controller;use App\Http\Requests\AdjustQuantityRequest;use App\Http\Requests\StoreComponentRequest;use App\Http\Requests\UpdateComponentRequest;-use App\Http\Requests\UploadFileRequest;+use App\Http\Traits\HandlesAdjustQuantity;use App\Models\Company;use App\Models\Component;-use DomainException;use Illuminate\Auth\Access\AuthorizationException;use Illuminate\Contracts\View\View;use Illuminate\Http\RedirectResponse;@@ -23,6 +22,8 @@ use Illuminate\Http\RedirectResponse;*/class ComponentsController extends Controller{+ use HandlesAdjustQuantity;+/*** Returns a view that invokes the ajax tables which actually contains* the content for the components listing, which is generated in getDatatable.@@ -253,35 +254,16 @@ class ComponentsController extends Controller}/**- * Apply an on-hand quantity delta (+/-) and log the change.- * Direction + amount from the form are converted to a signed delta- * for the AdjustsQuantity trait. Below-zero attempts surface as a- * flash error rather than a 500.+ * Apply an on-hand quantity delta (+/-) and log the change. The+ * shared body lives on the HandlesAdjustQuantity trait; this method+ * only owns the redirect-response shape.*/public function adjustQuantity(AdjustQuantityRequest $request, Component $component): RedirectResponse{- $this->authorize('update', $component);-- $filename = null;- if ($request->hasFile('file')) {- $filename = app(UploadFileRequest::class)->handleFile(- parent::getMapStoragePath()['components'],- parent::getMapFilePrefix()['components'].'-'.$component->id,- $request->file('file'),- );- }-- try {- $component->adjustQuantity(- (int) $request->input('amount'),- $request->input('note'),- $request->input('order_number'),- $filename,- );- } catch (DomainException) {- return redirect()->back()->with('error', trans('general.adjust_quantity_below_zero'));- }+ $error = $this->runAdjustQuantity($request, $component, 'components');- return redirect()->back()->with('success', trans('general.adjust_quantity_success'));+ return $error+ ? redirect()->back()->with('error', $error)+ : redirect()->back()->with('success', trans('general.adjust_quantity_success'));}}diff --git a/app/Http/Controllers/Consumables/ConsumablesController.php b/app/Http/Controllers/Consumables/ConsumablesController.phpindex 4e14f54a53..275945ae0e 100644--- a/app/Http/Controllers/Consumables/ConsumablesController.php+++ b/app/Http/Controllers/Consumables/ConsumablesController.php@@ -7,10 +7,9 @@ use App\Http\Controllers\Controller;use App\Http\Requests\AdjustQuantityRequest;use App\Http\Requests\ImageUploadRequest;use App\Http\Requests\StoreConsumableRequest;-use App\Http\Requests\UploadFileRequest;+use App\Http\Traits\HandlesAdjustQuantity;use App\Models\Company;use App\Models\Consumable;-use DomainException;use Illuminate\Auth\Access\AuthorizationException;use Illuminate\Contracts\View\View;use Illuminate\Http\RedirectResponse;@@ -24,6 +23,8 @@ use Illuminate\Support\Facades\Storage;*/class ConsumablesController extends Controller{+ use HandlesAdjustQuantity;+/*** Return a view to display component information.*@@ -254,35 +255,16 @@ class ConsumablesController extends Controller}/**- * Apply an on-hand quantity delta (+/-) and log the change.- * Direction + amount from the form are converted to a signed delta- * for the AdjustsQuantity trait. Below-zero attempts surface as a- * flash error rather than a 500.+ * Apply an on-hand quantity delta (+/-) and log the change. The+ * shared body lives on the HandlesAdjustQuantity trait; this method+ * only owns the redirect-response shape.*/public function adjustQuantity(AdjustQuantityRequest $request, Consumable $consumable): RedirectResponse{- $this->authorize('update', $consumable);-- $filename = null;- if ($request->hasFile('file')) {- $filename = app(UploadFileRequest::class)->handleFile(- parent::getMapStoragePath()['consumables'],- parent::getMapFilePrefix()['consumables'].'-'.$consumable->id,- $request->file('file'),- );- }-- try {- $consumable->adjustQuantity(- (int) $request->input('amount'),- $request->input('note'),- $request->input('order_number'),- $filename,- );- } catch (DomainException) {- return redirect()->back()->with('error', trans('general.adjust_quantity_below_zero'));- }+ $error = $this->runAdjustQuantity($request, $consumable, 'consumables');- return redirect()->back()->with('success', trans('general.adjust_quantity_success'));+ return $error+ ? redirect()->back()->with('error', $error)+ : redirect()->back()->with('success', trans('general.adjust_quantity_success'));}}diff --git a/app/Http/Traits/HandlesAdjustQuantity.php b/app/Http/Traits/HandlesAdjustQuantity.phpnew file mode 100644index 0000000000..da3601e4e3--- /dev/null+++ b/app/Http/Traits/HandlesAdjustQuantity.php@@ -0,0 +1,57 @@+<?php++namespace App\Http\Traits;++use App\Http\Controllers\Controller;+use App\Http\Requests\AdjustQuantityRequest;+use App\Http\Requests\UploadFileRequest;+use DomainException;+use Illuminate\Database\Eloquent\Model;++/**+ * Shared body of the adjust-quantity controller action. Web and API+ * controllers for Accessory / Consumable / Component all run the same+ * sequence — authorize the update, save an optional receipt attachment,+ * call the AdjustsQuantity model trait, and translate a DomainException+ * (would-drop-below-in-use) into the shared error string. Each controller+ * still owns its own response shape (redirect vs JSON) around that+ * shared work.+ */+trait HandlesAdjustQuantity+{+ /**+ * Run the shared adjust-quantity work. Returns null on success or a+ * translated error string on failure, so the caller can wrap the+ * outcome in whichever response shape (RedirectResponse or+ * JsonResponse) is appropriate for the invoking controller.+ */+ protected function runAdjustQuantity(+ AdjustQuantityRequest $request,+ Model $model,+ string $storageKey,+ ): ?string {+ $this->authorize('update', $model);++ $filename = null;+ if ($request->hasFile('file')) {+ $filename = app(UploadFileRequest::class)->handleFile(+ Controller::getMapStoragePath()[$storageKey],+ Controller::getMapFilePrefix()[$storageKey].'-'.$model->id,+ $request->file('file'),+ );+ }++ try {+ $model->adjustQuantity(+ (int) $request->input('amount'),+ $request->input('note'),+ $request->input('order_number'),+ $filename,+ );+ } catch (DomainException) {+ return trans('general.adjust_quantity_below_zero');+ }++ return null;+ }+}