1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-20 08:21:34 +02:00
invoiceninja/app/Http/Controllers/ProductApiController.php
2019-01-30 22:25:37 +11:00

196 lines
4.8 KiB
PHP

<?php
namespace App\Http\Controllers;
use App\Http\Requests\ProductRequest;
use App\Http\Requests\CreateProductRequest;
use App\Http\Requests\UpdateProductRequest;
use App\Models\Product;
use App\Ninja\Repositories\ProductRepository;
/**
* Class ProductApiController.
*/
class ProductApiController extends BaseAPIController
{
/**
* @var string
*/
protected $entityType = ENTITY_PRODUCT;
/**
* @var ProductRepository
*/
protected $productRepo;
/**
* ProductApiController constructor.
*
* @param ProductRepository $productRepo
*/
public function __construct(ProductRepository $productRepo)
{
parent::__construct();
$this->productRepo = $productRepo;
}
/**
* @SWG\Get(
* path="/products",
* summary="List products",
* operationId="listProducts",
* tags={"product"},
* @SWG\Response(
* response=200,
* description="A list of products",
* @SWG\Schema(type="array", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function index()
{
$products = Product::scope()
->withTrashed()
->orderBy('updated_at', 'desc');
return $this->listResponse($products);
}
/**
* @SWG\Get(
* path="/products/{product_id}",
* summary="Retrieve a product",
* operationId="getProduct",
* tags={"product"},
* @SWG\Parameter(
* in="path",
* name="product_id",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=200,
* description="A single product",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function show(ProductRequest $request)
{
return $this->itemResponse($request->entity());
}
/**
* @SWG\Post(
* path="/products",
* summary="Create a product",
* operationId="createProduct",
* tags={"product"},
* @SWG\Parameter(
* in="body",
* name="body",
* @SWG\Schema(ref="#/definitions/Product")
* ),
* @SWG\Response(
* response=200,
* description="New product",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function store(CreateProductRequest $request)
{
$product = $this->productRepo->save($request->input());
return $this->itemResponse($product);
}
/**
* @SWG\Put(
* path="/products/{product_id}",
* summary="Update a product",
* operationId="updateProduct",
* tags={"product"},
* @SWG\Parameter(
* in="path",
* name="product_id",
* type="integer",
* required=true
* ),
* @SWG\Parameter(
* in="body",
* name="product",
* @SWG\Schema(ref="#/definitions/Product")
* ),
* @SWG\Response(
* response=200,
* description="Updated product",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*
* @param mixed $publicId
*/
public function update(UpdateProductRequest $request, $publicId)
{
if ($request->action) {
return $this->handleAction($request);
}
$data = $request->input();
$data['public_id'] = $publicId;
$product = $this->productRepo->save($data, $request->entity());
return $this->itemResponse($product);
}
/**
* @SWG\Delete(
* path="/products/{product_id}",
* summary="Delete a product",
* operationId="deleteProduct",
* tags={"product"},
* @SWG\Parameter(
* in="path",
* name="product_id",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=200,
* description="Deleted product",
* @SWG\Schema(type="object", @SWG\Items(ref="#/definitions/Product"))
* ),
* @SWG\Response(
* response="default",
* description="an ""unexpected"" error"
* )
* )
*/
public function destroy(UpdateProductRequest $request)
{
$product = $request->entity();
$this->productRepo->delete($product);
return $this->itemResponse($product);
}
}