shipping-portal/app/Classes/General/Abstracts/Abstract2ControllerLogic.php

<?php

namespace App\Classes\General\Abstracts;


use App\Classes\Exceptions\ErrorException;
use App\Classes\Exceptions\InternalServerErrorException;
use App\Classes\ValueObjects\Constants\Notifications;
use App\Classes\ValueObjects\Constants\HttpStatus;
use App\Classes\ValueObjects\Response\ApiResponseObject;
use ErrorException as GeneralExceptions;
use TypeError;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Http\Resources\Json\ResourceCollection;
use Illuminate\Support\Facades\DB;

abstract class Abstract2ControllerLogic
{

    /**
     * @return array
     */
    abstract protected function notification(): array;

    /**
     * @return string
     */
    private function getNotificationTitle():string {
        return $this->notification()['title'] ? $this->notification()['title']: Notifications::UNDEFINED['title'];
    }

    /**
     * @return string
     */
    private function getNotificationMessage():string {
        return $this->notification()['message'] ? $this->notification()['message']: Notifications::UNDEFINED['message'];
    }

    /**
     * @param Request $request
     * @return BinaryFileResponse
     * @throws ErrorException
     */
    abstract protected function logic(Request $request) : BinaryFileResponse;

    /**
     * @param Request $request
     * @return BinaryFileResponse
     */
    public function execute(Request $request) : BinaryFileResponse  {

        try {

            DB::beginTransaction();

            $response = $this->logic($request);

            DB::commit();

            return $response;

        } catch (ErrorException|GeneralExceptions|TypeError  $exception){
            abort(404, $exception->getMessage());
        }
    }

    /**
     * @param array|null $data
     * @return JsonResponse
     */
    public function response(?array $data = []) : JsonResponse {

        return (new ApiResponseObject($this->getNotificationTitle().' Successful',
            $this->getNotificationMessage(),
            HttpStatus::OK_WITH_MESSAGE, $data))->handler();
    }

    /**
     * @param JsonResource $resource
     * @return JsonResponse
     */
    public function resourceResponse(JsonResource $resource){
        return $this->response(['data' => $resource]);
    }

    /**
     * @param ResourceCollection $collection
     * @return JsonResponse
     */
    public function collectionResponse(ResourceCollection $collection){
        return $this->response(json_decode($collection->response()->getContent(), true));
    }

}