mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-09-20 16:31:33 +02:00
482 lines
18 KiB
PHP
482 lines
18 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Http\Controllers;
|
|
|
|
use App\Factory\PaymentTermFactory;
|
|
use App\Filters\PaymentTermFilters;
|
|
use App\Http\Requests\PaymentTerm\CreatePaymentTermRequest;
|
|
use App\Http\Requests\PaymentTerm\DestroyPaymentTermRequest;
|
|
use App\Http\Requests\PaymentTerm\EditPaymentTermRequest;
|
|
use App\Http\Requests\PaymentTerm\ShowPaymentTermRequest;
|
|
use App\Http\Requests\PaymentTerm\StorePaymentTermRequest;
|
|
use App\Http\Requests\PaymentTerm\UpdatePaymentTermRequest;
|
|
use App\Models\PaymentTerm;
|
|
use App\Repositories\PaymentTermRepository;
|
|
use App\Transformers\PaymentTermTransformer;
|
|
use App\Utils\Traits\MakesHash;
|
|
use Illuminate\Http\Response;
|
|
|
|
class PaymentTermController extends BaseController
|
|
{
|
|
use MakesHash;
|
|
|
|
protected $entity_type = PaymentTerm::class;
|
|
|
|
protected $entity_transformer = PaymentTermTransformer::class;
|
|
|
|
/**
|
|
* @var PaymentTermRepository
|
|
*/
|
|
protected $payment_term_repo;
|
|
|
|
/**
|
|
* PaymentTermController constructor.
|
|
*
|
|
* @param PaymentTermRepository $payment_term_repo The payment term repo
|
|
*/
|
|
public function __construct(PaymentTermRepository $payment_term_repo)
|
|
{
|
|
parent::__construct();
|
|
|
|
$this->payment_term_repo = $payment_term_repo;
|
|
}
|
|
|
|
/**
|
|
* @OA\Get(
|
|
* path="/api/v1/payment_terms",
|
|
* operationId="getPaymentTerms",
|
|
* tags={"payment_terms"},
|
|
* summary="Gets a list of payment terms",
|
|
* description="Lists payment terms",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\Parameter(ref="#/components/parameters/index"),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="A list of payment terms",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
*/
|
|
public function index(PaymentTermFilters $filters)
|
|
{
|
|
$payment_terms = PaymentTerm::filter($filters);
|
|
|
|
return $this->listResponse($payment_terms);
|
|
}
|
|
|
|
/**
|
|
* Show the form for creating a new resource.
|
|
*
|
|
* @param CreatePaymentTermRequest $request The request
|
|
*
|
|
* @return Response
|
|
*
|
|
*
|
|
*
|
|
* @OA\Get(
|
|
* path="/api/v1/payment_terms/create",
|
|
* operationId="getPaymentTermsCreate",
|
|
* tags={"payment_terms"},
|
|
* summary="Gets a new blank PaymentTerm object",
|
|
* description="Returns a blank object with default values",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="A blank PaymentTerm object",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/Payment"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
*
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
*/
|
|
public function create(CreatePaymentTermRequest $request)
|
|
{
|
|
/** @var \App\Models\User $user */
|
|
$user = auth()->user();
|
|
$payment_term = PaymentTermFactory::create($user->company()->id, $user->id);
|
|
|
|
return $this->itemResponse($payment_term);
|
|
}
|
|
|
|
/**
|
|
* Store a newly created resource in storage.
|
|
*
|
|
* @param StorePaymentTermRequest $request The request
|
|
*
|
|
* @return Response
|
|
*
|
|
*
|
|
*
|
|
* @OA\Post(
|
|
* path="/api/v1/payment_terms",
|
|
* operationId="storePaymentTerm",
|
|
* tags={"payment_terms"},
|
|
* summary="Adds a Payment",
|
|
* description="Adds a Payment Term to the system",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\RequestBody(
|
|
* description="The payment_terms request",
|
|
* required=true,
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the saved Payment object",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
*
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
*/
|
|
public function store(StorePaymentTermRequest $request)
|
|
{
|
|
/** @var \App\Models\User $user */
|
|
$user = auth()->user();
|
|
|
|
$payment_term = PaymentTermFactory::create($user->company()->id, $user->id);
|
|
$payment_term->fill($request->all());
|
|
$payment_term->save();
|
|
|
|
return $this->itemResponse($payment_term->fresh());
|
|
}
|
|
|
|
/**
|
|
* @OA\Get(
|
|
* path="/api/v1/payment_terms/{id}",
|
|
* operationId="showPaymentTerm",
|
|
* tags={"payment_terms"},
|
|
* summary="Shows a Payment Term",
|
|
* description="Displays an Payment Term by id",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\Parameter(
|
|
* name="id",
|
|
* in="path",
|
|
* description="The Payment Term Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the Payment Term object",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
*
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
* @param ShowPaymentTermRequest $request
|
|
* @param PaymentTerm $payment_term
|
|
* @return Response|mixed
|
|
*/
|
|
public function show(ShowPaymentTermRequest $request, PaymentTerm $payment_term)
|
|
{
|
|
return $this->itemResponse($payment_term);
|
|
}
|
|
|
|
/**
|
|
* @OA\Get(
|
|
* path="/api/v1/payment_terms/{id}/edit",
|
|
* operationId="editPaymentTerms",
|
|
* tags={"payment_terms"},
|
|
* summary="Shows an Payment Term for editting",
|
|
* description="Displays an Payment Term by id",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\Parameter(
|
|
* name="id",
|
|
* in="path",
|
|
* description="The Payment Term Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the Payment object",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
*
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
* @param EditPaymentTermRequest $request
|
|
* @param PaymentTerm $payment_term
|
|
* @return Response|mixed
|
|
*/
|
|
public function edit(EditPaymentTermRequest $request, PaymentTerm $payment_term)
|
|
{
|
|
return $this->itemResponse($payment_term);
|
|
}
|
|
|
|
/**
|
|
* Update the specified resource in storage.
|
|
*
|
|
* @param UpdatePaymentTermRequest $request The request
|
|
* @param PaymentTerm $payment_term The payment term
|
|
*
|
|
* @return Response
|
|
*
|
|
*
|
|
* @OA\Put(
|
|
* path="/api/v1/payment_terms/{id}",
|
|
* operationId="updatePaymentTerm",
|
|
* tags={"payment_terms"},
|
|
* summary="Updates a Payment Term",
|
|
* description="Handles the updating of an Payment Termby id",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\Parameter(
|
|
* name="id",
|
|
* in="path",
|
|
* description="The Payment Term Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the Payment Term object",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
*
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
*/
|
|
public function update(UpdatePaymentTermRequest $request, PaymentTerm $payment_term)
|
|
{
|
|
$payment_term->fill($request->all());
|
|
$payment_term->save();
|
|
|
|
return $this->itemResponse($payment_term->fresh());
|
|
}
|
|
|
|
/**
|
|
* Remove the specified resource from storage.
|
|
*
|
|
* @param DestroyPaymentTermRequest $request
|
|
* @param PaymentTerm $payment_term
|
|
*
|
|
* @return Response
|
|
*
|
|
*
|
|
* @throws \Exception
|
|
* @OA\Delete(
|
|
* path="/api/v1/payment_terms/{id}",
|
|
* operationId="deletePaymentTerm",
|
|
* tags={"payment_termss"},
|
|
* summary="Deletes a Payment Term",
|
|
* description="Handles the deletion of an PaymentTerm by id",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/include"),
|
|
* @OA\Parameter(
|
|
* name="id",
|
|
* in="path",
|
|
* description="The Payment Term Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns a HTTP status",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
*
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
*/
|
|
public function destroy(DestroyPaymentTermRequest $request, PaymentTerm $payment_term)
|
|
{
|
|
$payment_term->delete();
|
|
|
|
return $this->itemResponse($payment_term->fresh());
|
|
}
|
|
|
|
/**
|
|
* Perform bulk actions on the list view.
|
|
*
|
|
* @return \Illuminate\Support\Collection
|
|
*
|
|
*
|
|
* @OA\Post(
|
|
* path="/api/v1/payment_terms/bulk",
|
|
* operationId="bulkPaymentTerms",
|
|
* tags={"payment_terms"},
|
|
* summary="Performs bulk actions on an array of payment terms",
|
|
* description="",
|
|
* @OA\Parameter(ref="#/components/parameters/X-API-TOKEN"),
|
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
|
* @OA\Parameter(ref="#/components/parameters/index"),
|
|
* @OA\RequestBody(
|
|
* description="Payment Ter,s",
|
|
* required=true,
|
|
* @OA\MediaType(
|
|
* mediaType="application/json",
|
|
* @OA\Schema(
|
|
* type="array",
|
|
* @OA\Items(
|
|
* type="integer",
|
|
* description="Array of hashed IDs to be bulk 'actioned",
|
|
* example="[0,1,2,3]",
|
|
* ),
|
|
* )
|
|
* )
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="The Payment Terms response",
|
|
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
|
|
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
|
|
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
|
|
* @OA\JsonContent(ref="#/components/schemas/PaymentTerm"),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=422,
|
|
* description="Validation error",
|
|
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
|
|
|
|
* ),
|
|
* @OA\Response(
|
|
* response="default",
|
|
* description="Unexpected Error",
|
|
* @OA\JsonContent(ref="#/components/schemas/Error"),
|
|
* ),
|
|
* )
|
|
*/
|
|
public function bulk()
|
|
{
|
|
/** @var \App\Models\User $user */
|
|
$user = auth()->user();
|
|
|
|
$action = request()->input('action');
|
|
|
|
$ids = request()->input('ids');
|
|
|
|
$payment_terms = PaymentTerm::withTrashed()->company()->find($this->transformKeys($ids));
|
|
|
|
$payment_terms->each(function ($payment_term, $key) use ($action, $user) {
|
|
if ($user->can('edit', $payment_term)) {
|
|
$this->payment_term_repo->{$action}($payment_term);
|
|
}
|
|
});
|
|
|
|
return $this->listResponse(PaymentTerm::withTrashed()->whereIn('id', $this->transformKeys($ids)));
|
|
}
|
|
}
|