mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
585 lines
21 KiB
PHP
585 lines
21 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2024. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Http\Controllers;
|
|
|
|
use App\Events\Expense\ExpenseWasCreated;
|
|
use App\Events\Expense\ExpenseWasUpdated;
|
|
use App\Factory\ExpenseFactory;
|
|
use App\Filters\ExpenseFilters;
|
|
use App\Http\Requests\Expense\BulkExpenseRequest;
|
|
use App\Http\Requests\Expense\CreateExpenseRequest;
|
|
use App\Http\Requests\Expense\DestroyExpenseRequest;
|
|
use App\Http\Requests\Expense\EditExpenseRequest;
|
|
use App\Http\Requests\Expense\ShowExpenseRequest;
|
|
use App\Http\Requests\Expense\StoreExpenseRequest;
|
|
use App\Http\Requests\Expense\UpdateExpenseRequest;
|
|
use App\Http\Requests\Expense\UploadExpenseRequest;
|
|
use App\Models\Account;
|
|
use App\Models\Expense;
|
|
use App\Repositories\ExpenseRepository;
|
|
use App\Transformers\ExpenseTransformer;
|
|
use App\Utils\Ninja;
|
|
use App\Utils\Traits\BulkOptions;
|
|
use App\Utils\Traits\MakesHash;
|
|
use App\Utils\Traits\SavesDocuments;
|
|
use App\Utils\Traits\Uploadable;
|
|
use Illuminate\Http\Response;
|
|
|
|
/**
|
|
* Class ExpenseController.
|
|
* @covers App\Http\Controllers\ExpenseController
|
|
*/
|
|
class ExpenseController extends BaseController
|
|
{
|
|
use MakesHash;
|
|
use Uploadable;
|
|
use BulkOptions;
|
|
use SavesDocuments;
|
|
|
|
protected $entity_type = Expense::class;
|
|
|
|
protected $entity_transformer = ExpenseTransformer::class;
|
|
|
|
/**
|
|
* @var ExpenseRepository
|
|
*/
|
|
protected $expense_repo;
|
|
|
|
/**
|
|
* ExpenseController constructor.
|
|
* @param ExpenseRepository $expense_repo
|
|
*/
|
|
public function __construct(ExpenseRepository $expense_repo)
|
|
{
|
|
parent::__construct();
|
|
|
|
$this->expense_repo = $expense_repo;
|
|
}
|
|
|
|
/**
|
|
* @OA\Get(
|
|
* path="/api/v1/expenses",
|
|
* operationId="getExpenses",
|
|
* tags={"expenses"},
|
|
* summary="Gets a list of expenses",
|
|
* description="Lists expenses, search and filters allow fine grained lists to be generated.
|
|
|
|
* Query parameters can be added to performed more fine grained filtering of the expenses, these are handled by the ExpenseFilters class which defines the methods available",
|
|
* @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 expenses",
|
|
* @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/Expense"),
|
|
* ),
|
|
* @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 ExpenseFilters $filters
|
|
* @return Response| \Illuminate\Http\JsonResponse|mixed
|
|
*/
|
|
public function index(ExpenseFilters $filters)
|
|
{
|
|
$expenses = Expense::filter($filters);
|
|
|
|
return $this->listResponse($expenses);
|
|
}
|
|
|
|
/**
|
|
* Display the specified resource.
|
|
*
|
|
* @param ShowExpenseRequest $request
|
|
* @param Expense $expense
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
* @OA\Get(
|
|
* path="/api/v1/expenses/{id}",
|
|
* operationId="showExpense",
|
|
* tags={"expenses"},
|
|
* summary="Shows a client",
|
|
* description="Displays a client 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 Expense Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the expense 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/Expense"),
|
|
* ),
|
|
* @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 show(ShowExpenseRequest $request, Expense $expense)
|
|
{
|
|
return $this->itemResponse($expense);
|
|
}
|
|
|
|
/**
|
|
* Show the form for editing the specified resource.
|
|
*
|
|
* @param EditExpenseRequest $request
|
|
* @param Expense $expense
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
* @OA\Get(
|
|
* path="/api/v1/expenses/{id}/edit",
|
|
* operationId="editExpense",
|
|
* tags={"expenses"},
|
|
* summary="Shows a client for editting",
|
|
* description="Displays a client 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 Expense Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the client 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/Expense"),
|
|
* ),
|
|
* @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 edit(EditExpenseRequest $request, Expense $expense)
|
|
{
|
|
return $this->itemResponse($expense);
|
|
}
|
|
|
|
/**
|
|
* Update the specified resource in storage.
|
|
*
|
|
* @param UpdateExpenseRequest $request
|
|
* @param Expense $expense
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
*
|
|
* @OA\Put(
|
|
* path="/api/v1/expenses/{id}",
|
|
* operationId="updateExpense",
|
|
* tags={"expenses"},
|
|
* summary="Updates a client",
|
|
* description="Handles the updating of a client 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 Expense Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the client 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/Expense"),
|
|
* ),
|
|
* @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(UpdateExpenseRequest $request, Expense $expense)
|
|
{
|
|
if ($request->entityIsDeleted($expense)) {
|
|
return $request->disallowUpdate();
|
|
}
|
|
|
|
$expense = $this->expense_repo->save($request->all(), $expense);
|
|
|
|
$this->uploadLogo($request->file('company_logo'), $expense->company, $expense);
|
|
|
|
event(new ExpenseWasUpdated($expense, $expense->company, Ninja::eventVars(auth()->user() ? auth()->user()->id : null)));
|
|
|
|
event('eloquent.updated: App\Models\Expense', $expense);
|
|
|
|
return $this->itemResponse($expense->fresh());
|
|
}
|
|
|
|
/**
|
|
* Show the form for creating a new resource.
|
|
*
|
|
* @param CreateExpenseRequest $request
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
*
|
|
* @OA\Get(
|
|
* path="/api/v1/expenses/create",
|
|
* operationId="getExpensesCreate",
|
|
* tags={"expenses"},
|
|
* summary="Gets a new blank client 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 client 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/Expense"),
|
|
* ),
|
|
* @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(CreateExpenseRequest $request)
|
|
{
|
|
/** @var \App\Models\User $user */
|
|
$user = auth()->user();
|
|
|
|
$expense = ExpenseFactory::create($user->company()->id, $user->id);
|
|
|
|
return $this->itemResponse($expense);
|
|
}
|
|
|
|
/**
|
|
* Store a newly created resource in storage.
|
|
*
|
|
* @param StoreExpenseRequest $request
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
*
|
|
* @OA\Post(
|
|
* path="/api/v1/expenses",
|
|
* operationId="storeExpense",
|
|
* tags={"expenses"},
|
|
* summary="Adds a client",
|
|
* description="Adds an client to a company",
|
|
* @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="Returns the saved client 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/Expense"),
|
|
* ),
|
|
* @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(StoreExpenseRequest $request)
|
|
{
|
|
/** @var \App\Models\User $user */
|
|
$user = auth()->user();
|
|
|
|
$expense = $this->expense_repo->save($request->all(), ExpenseFactory::create($user->company()->id, $user->id));
|
|
|
|
event(new ExpenseWasCreated($expense, $expense->company, Ninja::eventVars($user ? $user->id : null)));
|
|
|
|
event('eloquent.created: App\Models\Expense', $expense);
|
|
|
|
return $this->itemResponse($expense);
|
|
}
|
|
|
|
/**
|
|
* Remove the specified resource from storage.
|
|
*
|
|
* @param DestroyExpenseRequest $request
|
|
* @param Expense $expense
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
* @throws \Exception
|
|
* @OA\Delete(
|
|
* path="/api/v1/expenses/{id}",
|
|
* operationId="deleteExpense",
|
|
* tags={"expenses"},
|
|
* summary="Deletes a client",
|
|
* description="Handles the deletion of a client 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 Expense 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(DestroyExpenseRequest $request, Expense $expense)
|
|
{
|
|
$this->expense_repo->delete($expense);
|
|
|
|
return $this->itemResponse($expense->fresh());
|
|
}
|
|
|
|
/**
|
|
* Perform bulk actions on the list view.
|
|
*
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
* @OA\Post(
|
|
* path="/api/v1/expenses/bulk",
|
|
* operationId="bulkExpenses",
|
|
* tags={"expenses"},
|
|
* summary="Performs bulk actions on an array of expenses",
|
|
* 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="User credentials",
|
|
* 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 Expense User 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/Expense"),
|
|
* ),
|
|
* @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(BulkExpenseRequest $request)
|
|
{
|
|
/** @var \App\Models\User $user */
|
|
$user = auth()->user();
|
|
|
|
$expenses = Expense::withTrashed()->find($request->ids);
|
|
|
|
if($request->action == 'bulk_categorize' && $user->can('edit', $expenses->first())) {
|
|
$this->expense_repo->categorize($expenses, $request->category_id);
|
|
$expenses = collect([]);
|
|
}
|
|
|
|
$expenses->each(function ($expense) use ($request, $user) {
|
|
if ($user->can('edit', $expense)) {
|
|
$this->expense_repo->{$request->action}($expense);
|
|
}
|
|
});
|
|
|
|
return $this->listResponse(Expense::withTrashed()->whereIn('id', $request->ids));
|
|
}
|
|
|
|
/**
|
|
* Returns a client statement.
|
|
*
|
|
* @return void [type] [description]
|
|
*/
|
|
public function statement()
|
|
{
|
|
//todo
|
|
}
|
|
|
|
/**
|
|
* Update the specified resource in storage.
|
|
*
|
|
* @param UploadExpenseRequest $request
|
|
* @param Expense $expense
|
|
* @return Response| \Illuminate\Http\JsonResponse
|
|
*
|
|
*
|
|
*
|
|
* @OA\Put(
|
|
* path="/api/v1/expenses/{id}/upload",
|
|
* operationId="uploadExpense",
|
|
* tags={"expense"},
|
|
* summary="Uploads a document to a expense",
|
|
* description="Handles the uploading of a document to a expense",
|
|
* @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 Expense Hashed ID",
|
|
* example="D2J234DFA",
|
|
* required=true,
|
|
* @OA\Schema(
|
|
* type="string",
|
|
* format="string",
|
|
* ),
|
|
* ),
|
|
* @OA\Response(
|
|
* response=200,
|
|
* description="Returns the Expense 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/Expense"),
|
|
* ),
|
|
* @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 upload(UploadExpenseRequest $request, Expense $expense)
|
|
{
|
|
if (! $this->checkFeature(Account::FEATURE_DOCUMENTS)) {
|
|
return $this->featureFailure();
|
|
}
|
|
|
|
if ($request->has('documents')) {
|
|
$this->saveDocuments($request->file('documents'), $expense, $request->input('is_public', true));
|
|
}
|
|
|
|
return $this->itemResponse($expense->fresh());
|
|
}
|
|
}
|