snipe-it/app/Http/Controllers/Consumables/ConsumablesController.php

<?php

namespace App\Http\Controllers\Consumables;

use App\Helpers\Helper;
use App\Http\Controllers\Controller;
use App\Http\Requests\AdjustQuantityRequest;
use App\Http\Requests\ImageUploadRequest;
use App\Http\Requests\StoreConsumableRequest;
use App\Http\Traits\HandlesAdjustQuantity;
use App\Models\Company;
use App\Models\Consumable;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Contracts\View\View;
use Illuminate\Http\RedirectResponse;
use Illuminate\Support\Facades\Storage;

/**
 * This controller handles all actions related to Consumables for
 * the Snipe-IT Asset Management application.
 *
 * @version    v1.0
 */
class ConsumablesController extends Controller
{
    use HandlesAdjustQuantity;

    /**
     * Return a view to display component information.
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @see ConsumablesController::getDatatable() method that generates the JSON response
     * @since [v1.0]
     *
     * @return View
     *
     * @throws AuthorizationException
     */
    public function index()
    {
        $this->authorize('index', Consumable::class);

        return view('consumables/index');
    }

    /**
     * Return a view to display the form view to create a new consumable
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @see ConsumablesController::postCreate() method that stores the form data
     * @since [v1.0]
     *
     * @return View
     *
     * @throws AuthorizationException
     */
    public function create()
    {
        $this->authorize('create', Consumable::class);

        return view('consumables.edit')->with('category_type', 'consumable')
            ->with('item', new Consumable);
    }

    /**
     * Validate and store new consumable data.
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @see ConsumablesController::getCreate() method that returns the form view
     * @since [v1.0]
     *
     * @param  ImageUploadRequest  $request
     * @return RedirectResponse
     *
     * @throws AuthorizationException
     */
    public function store(StoreConsumableRequest $request)
    {
        $this->authorize('create', Consumable::class);
        $consumable = new Consumable;
        $consumable->name = $request->input('name');
        $consumable->category_id = $request->input('category_id');
        $consumable->supplier_id = $request->input('supplier_id');
        $consumable->location_id = $request->input('location_id');
        $consumable->company_id = Company::getIdForCurrentUser($request->input('company_id'));
        // order_number moved off the parent Consumable column to Orders / OrderItems.
        $consumable->min_amt = $request->input('min_amt');
        $consumable->manufacturer_id = $request->input('manufacturer_id');
        $consumable->model_number = $request->input('model_number');
        $consumable->item_no = $request->input('item_no');
        $consumable->purchase_date = $request->input('purchase_date');
        $consumable->purchase_cost = $request->input('purchase_cost');
        $consumable->qty = $request->input('qty');
        $consumable->created_by = auth()->id();
        $consumable->notes = $request->input('notes');

        if ($request->has('use_cloned_image')) {
            $cloned_model_img = Consumable::select('image')->find($request->input('clone_image_from_id'));
            if ($cloned_model_img) {
                $new_image_name = 'clone-'.date('U').'-'.$cloned_model_img->image;
                $new_image = 'consumables/'.$new_image_name;
                Storage::disk('public')->copy('consumables/'.$cloned_model_img->image, $new_image);
                $consumable->image = $new_image_name;
            }

        } else {
            $consumable = $request->handleImages($consumable);
        }

        if ($request->input('redirect_option') === 'back') {
            session()->put(['redirect_option' => 'index']);
        } else {
            session()->put(['redirect_option' => $request->input('redirect_option')]);
        }

        if ($consumable->save()) {
            $this->enrichInitialOrderFromRequest($request, $consumable);

            return Helper::getRedirectOption($request, $consumable->id, 'Consumables')
                ->with('success', trans('admin/consumables/message.create.success'));
        }

        return redirect()->back()->withInput()->withErrors($consumable->getErrors());
    }

    /**
     * Returns a form view to edit a consumable.
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @param  int  $consumableId
     *
     * @see ConsumablesController::postEdit() method that stores the form data.
     * @since [v1.0]
     */
    public function edit(Consumable $consumable): View|RedirectResponse
    {
        $this->authorize($consumable);
        if ($safeReferer = Helper::sameOriginUrl(url()->previous())) {
            session()->put('url.intended', $safeReferer);
        }

        return view('consumables/edit')
            ->with('item', $consumable)
            ->with('category_type', 'consumable');

    }

    /**
     * Returns a form view to edit a consumable.
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @param  ImageUploadRequest  $request
     * @param  int  $consumableId
     * @return RedirectResponse
     *
     * @throws AuthorizationException
     *
     * @see ConsumablesController::getEdit() method that stores the form data.
     * @since [v1.0]
     */
    public function update(StoreConsumableRequest $request, Consumable $consumable)
    {
        $this->authorize($consumable);

        // qty and order_number are intentionally NOT accepted on update.
        // See AccessoriesController::update for rationale. supplier_id is
        // editable again (imperfect single-value semantics accepted for
        // the info-panel display).
        $consumable->name = $request->input('name');
        $consumable->category_id = $request->input('category_id');
        $consumable->location_id = $request->input('location_id');
        $consumable->company_id = Company::getIdForCurrentUser($request->input('company_id'));
        $consumable->min_amt = $request->input('min_amt');
        $consumable->manufacturer_id = $request->input('manufacturer_id');
        $consumable->model_number = $request->input('model_number');
        $consumable->item_no = $request->input('item_no');
        // supplier_id, purchase_date, purchase_cost are create-only on
        // the parent. Post-create acquisitions live as Orders +
        // OrderItems, so the edit form drops them and the controller
        // stops overwriting the parent values.
        $consumable->notes = $request->input('notes');

        $consumable = $request->handleImages($consumable);

        session()->put(['redirect_option' => $request->input('redirect_option')]);

        if ($consumable->save()) {
            return Helper::getRedirectOption($request, $consumable->id, 'Consumables')
                ->with('success', trans('admin/consumables/message.update.success'));
        }

        return redirect()->back()->withInput()->withErrors($consumable->getErrors());
    }

    /**
     * Delete a consumable.
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @param  int  $consumableId
     *
     * @since [v1.0]
     *
     * @return RedirectResponse
     *
     * @throws AuthorizationException
     */
    public function destroy($consumableId)
    {
        if (is_null($consumable = Consumable::find($consumableId))) {
            return redirect()->route('consumables.index')->with('error', trans('admin/consumables/message.not_found'));
        }
        $this->authorize($consumable);

        $consumable->delete();

        // Redirect to the locations management page
        return redirect()->route('consumables.index')->with('success', trans('admin/consumables/message.delete.success'));
    }

    /**
     * Return a view to display component information.
     *
     * @author [A. Gianotto] [<snipe@snipe.net>]
     *
     * @see ConsumablesController::getDataView() method that generates the JSON response
     * @since [v1.0]
     *
     * @param  int  $consumableId
     * @return View
     *
     * @throws AuthorizationException
     */
    public function show(Consumable $consumable)
    {
        $consumable = Consumable::withCount('users as users_consumables')->find($consumable->id);
        $this->authorize($consumable);

        return view('consumables/view', compact('consumable'));
    }

    public function clone(Consumable $consumable): View
    {
        $this->authorize('create', $consumable);
        $consumable_to_close = $consumable;
        $consumable = clone $consumable_to_close;
        $consumable->id = null;
        $consumable->created_by = null;

        return view('consumables/edit')
            ->with('cloned_model', $consumable_to_close)
            ->with('item', $consumable);
    }

    /**
     * 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
    {
        $error = $this->runAdjustQuantity($request, $consumable, 'consumables');

        if ($error) {
            return redirect()->back()->with('error', $error);
        }

        return redirect()
            ->route('consumables.show', $consumable)
            ->withFragment('history')
            ->with('success', trans('general.adjust_quantity_success'));
    }
}