303 lines
13 KiB
PHP
303 lines
13 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Kimai time-tracking app.
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace App\API;
|
|
|
|
use App\Customer\CustomerService;
|
|
use App\Entity\Customer;
|
|
use App\Entity\CustomerRate;
|
|
use App\Entity\User;
|
|
use App\Form\API\CustomerApiEditForm;
|
|
use App\Form\API\CustomerRateApiForm;
|
|
use App\Repository\CustomerRateRepository;
|
|
use App\Repository\CustomerRepository;
|
|
use App\Repository\Query\CustomerQuery;
|
|
use App\Utils\SearchTerm;
|
|
use FOS\RestBundle\Controller\Annotations as Rest;
|
|
use FOS\RestBundle\Request\ParamFetcherInterface;
|
|
use FOS\RestBundle\View\View;
|
|
use FOS\RestBundle\View\ViewHandlerInterface;
|
|
use OpenApi\Attributes as OA;
|
|
use Symfony\Bridge\Doctrine\Attribute\MapEntity;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
use Symfony\Component\Routing\Attribute\Route;
|
|
use Symfony\Component\Security\Http\Attribute\IsGranted;
|
|
|
|
#[Route(path: '/customers')]
|
|
#[IsGranted('API')]
|
|
#[OA\Tag(name: 'Customer')]
|
|
final class CustomerController extends BaseApiController
|
|
{
|
|
public const GROUPS_ENTITY = ['Default', 'Entity', 'Customer', 'Customer_Entity'];
|
|
public const GROUPS_COLLECTION = ['Default', 'Collection', 'Customer'];
|
|
public const GROUPS_RATE = ['Default', 'Entity', 'Customer_Rate'];
|
|
|
|
public function __construct(
|
|
private readonly ViewHandlerInterface $viewHandler,
|
|
private readonly CustomerRepository $repository,
|
|
private readonly CustomerRateRepository $customerRateRepository,
|
|
private readonly CustomerService $customerService,
|
|
) {
|
|
}
|
|
|
|
/**
|
|
* Fetch customers
|
|
*/
|
|
#[OA\Response(response: 200, description: 'Returns a collection of customers', content: new OA\JsonContent(type: 'array', items: new OA\Items(ref: '#/components/schemas/CustomerCollection')))]
|
|
#[Route(methods: ['GET'], path: '', name: 'get_customers')]
|
|
#[Rest\QueryParam(name: 'visible', requirements: '1|2|3', default: 1, strict: true, nullable: true, description: 'Visibility status to filter customers: 1=visible, 2=hidden, 3=both')]
|
|
#[Rest\QueryParam(name: 'order', requirements: 'ASC|DESC', strict: true, nullable: true, description: 'The result order. Allowed values: ASC, DESC (default: ASC)')]
|
|
#[Rest\QueryParam(name: 'orderBy', requirements: 'id|name', strict: true, nullable: true, description: 'The field by which results will be ordered. Allowed values: id, name (default: name)')]
|
|
#[Rest\QueryParam(name: 'term', description: 'Free search term', nullable: true)]
|
|
public function cgetAction(ParamFetcherInterface $paramFetcher): Response
|
|
{
|
|
/** @var User $user */
|
|
$user = $this->getUser();
|
|
|
|
$query = new CustomerQuery();
|
|
$query->loadTeams();
|
|
$query->setCurrentUser($user);
|
|
|
|
$order = $paramFetcher->get('order');
|
|
if (\is_string($order) && $order !== '') {
|
|
$query->setOrder($order);
|
|
}
|
|
|
|
$orderBy = $paramFetcher->get('orderBy');
|
|
if (\is_string($orderBy) && $orderBy !== '') {
|
|
$query->setOrderBy($orderBy);
|
|
}
|
|
|
|
$visible = $paramFetcher->get('visible');
|
|
if (is_numeric($visible)) {
|
|
$query->setVisibility((int) $visible);
|
|
}
|
|
|
|
$term = $paramFetcher->get('term');
|
|
if (\is_string($term) && $term !== '') {
|
|
$query->setSearchTerm(new SearchTerm($term));
|
|
}
|
|
|
|
$query->setIsApiCall(true);
|
|
$data = $this->repository->getCustomersForQuery($query);
|
|
$view = new View($data, 200);
|
|
$view->getContext()->setGroups(self::GROUPS_COLLECTION);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Fetch customer
|
|
*/
|
|
#[OA\Response(response: 200, description: 'Returns one customer entity', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))]
|
|
#[Route(methods: ['GET'], path: '/{id}', name: 'get_customer', requirements: ['id' => '\d+'])]
|
|
#[IsGranted('view', 'customer')]
|
|
public function getAction(Customer $customer): Response
|
|
{
|
|
$view = new View($customer, 200);
|
|
$view->getContext()->setGroups(self::GROUPS_ENTITY);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Create customer
|
|
*/
|
|
#[OA\Post(description: 'Creates a new customer and returns it afterwards', responses: [new OA\Response(response: 200, description: 'Returns the new created customer', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))])]
|
|
#[OA\RequestBody(required: true, content: new OA\JsonContent(ref: '#/components/schemas/CustomerEditForm'))]
|
|
#[Route(methods: ['POST'], path: '', name: 'post_customer')]
|
|
public function postAction(Request $request, CustomerService $customerService): Response
|
|
{
|
|
if (!$this->isGranted('create_customer')) {
|
|
throw $this->createAccessDeniedException('User cannot create customers');
|
|
}
|
|
|
|
$customer = $customerService->createNewCustomer('');
|
|
|
|
$form = $this->createForm(CustomerApiEditForm::class, $customer, [
|
|
'include_budget' => $this->isGranted('budget', $customer),
|
|
'include_time' => $this->isGranted('time', $customer),
|
|
]);
|
|
|
|
$form->submit($request->request->all());
|
|
|
|
if ($form->isValid()) {
|
|
$this->customerService->saveCustomer($customer);
|
|
|
|
$view = new View($customer, 200);
|
|
$view->getContext()->setGroups(self::GROUPS_ENTITY);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
$view = new View($form);
|
|
$view->getContext()->setGroups(self::GROUPS_ENTITY);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Update customer
|
|
*/
|
|
#[IsGranted('edit', 'customer')]
|
|
#[OA\Patch(description: 'Update an existing customer, you can pass all or just a subset of all attributes', responses: [new OA\Response(response: 200, description: 'Returns the updated customer', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))])]
|
|
#[OA\RequestBody(required: true, content: new OA\JsonContent(ref: '#/components/schemas/CustomerEditForm'))]
|
|
#[OA\Parameter(name: 'id', in: 'path', description: 'Customer ID to update', required: true)]
|
|
#[Route(methods: ['PATCH'], path: '/{id}', name: 'patch_customer', requirements: ['id' => '\d+'])]
|
|
public function patchAction(Request $request, Customer $customer): Response
|
|
{
|
|
$this->customerService->loadMetaFields($customer);
|
|
|
|
$form = $this->createForm(CustomerApiEditForm::class, $customer, [
|
|
'include_budget' => $this->isGranted('budget', $customer),
|
|
'include_time' => $this->isGranted('time', $customer),
|
|
]);
|
|
|
|
$form->setData($customer);
|
|
$form->submit($request->request->all(), false);
|
|
|
|
if (false === $form->isValid()) {
|
|
$view = new View($form, Response::HTTP_OK);
|
|
$view->getContext()->setGroups(self::GROUPS_ENTITY);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
$this->customerService->saveCustomer($customer);
|
|
|
|
$view = new View($customer, Response::HTTP_OK);
|
|
$view->getContext()->setGroups(self::GROUPS_ENTITY);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Delete customer
|
|
*
|
|
* [DANGER] This will also delete ALL linked projects, project activities and timesheets.
|
|
* Do you want to use `PATCH` instead and mark it as inactive with `{visible: false}` instead?
|
|
*/
|
|
#[IsGranted('delete', 'customer')]
|
|
#[OA\Delete(responses: [new OA\Response(response: 204, description: 'Delete one customer')])]
|
|
#[OA\Parameter(name: 'id', description: 'Customer ID to delete', in: 'path', required: true)]
|
|
#[Route(path: '/{id}', name: 'delete_customer', requirements: ['id' => '\d+'], methods: ['DELETE'])]
|
|
public function deleteAction(Customer $customer): Response
|
|
{
|
|
$this->customerService->deleteCustomer($customer);
|
|
|
|
$view = new View(null, Response::HTTP_NO_CONTENT);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Update customer custom-field
|
|
*/
|
|
#[IsGranted('edit', 'customer')]
|
|
#[OA\Response(response: 200, description: 'Sets the value of an existing/configured meta-field. You cannot create unknown meta-fields, if the given name is not a configured meta-field, this will return an exception.', content: new OA\JsonContent(ref: '#/components/schemas/CustomerEntity'))]
|
|
#[OA\Parameter(name: 'id', in: 'path', description: 'Customer record ID to set the meta-field value for', required: true)]
|
|
#[Route(methods: ['PATCH'], path: '/{id}/meta', requirements: ['id' => '\d+'])]
|
|
#[Rest\RequestParam(name: 'name', strict: true, nullable: false, description: 'The meta-field name')]
|
|
#[Rest\RequestParam(name: 'value', strict: true, nullable: false, description: 'The meta-field value')]
|
|
public function metaAction(Customer $customer, ParamFetcherInterface $paramFetcher): Response
|
|
{
|
|
$this->customerService->loadMetaFields($customer);
|
|
|
|
$name = $paramFetcher->get('name');
|
|
$value = $paramFetcher->get('value');
|
|
|
|
if (null === ($meta = $customer->getMetaField($name))) {
|
|
throw $this->createNotFoundException('Unknown meta-field requested');
|
|
}
|
|
|
|
$meta->setValue($value);
|
|
|
|
$this->customerService->saveCustomer($customer);
|
|
|
|
$view = new View($customer, 200);
|
|
$view->getContext()->setGroups(self::GROUPS_ENTITY);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Fetch rates for customer
|
|
*/
|
|
#[IsGranted('edit', 'customer')]
|
|
#[OA\Response(response: 200, description: 'Returns a collection of customer rate entities', content: new OA\JsonContent(type: 'array', items: new OA\Items(ref: '#/components/schemas/CustomerRate')))]
|
|
#[OA\Parameter(name: 'id', in: 'path', description: 'The customer whose rates will be returned', required: true)]
|
|
#[Route(methods: ['GET'], path: '/{id}/rates', name: 'get_customer_rates', requirements: ['id' => '\d+'])]
|
|
public function getRatesAction(Customer $customer): Response
|
|
{
|
|
$rates = $this->customerRateRepository->getRatesForCustomer($customer);
|
|
|
|
$view = new View($rates, 200);
|
|
$view->getContext()->setGroups(self::GROUPS_RATE);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Delete rate for customer
|
|
*/
|
|
#[IsGranted('edit', 'customer')]
|
|
#[OA\Delete(responses: [new OA\Response(response: 204, description: 'Returns no content: 204 on successful delete')])]
|
|
#[OA\Parameter(name: 'id', in: 'path', description: 'The customer whose rate will be removed', required: true)]
|
|
#[OA\Parameter(name: 'rateId', in: 'path', description: 'The rate to remove', required: true)]
|
|
#[Route(methods: ['DELETE'], path: '/{id}/rates/{rateId}', name: 'delete_customer_rate', requirements: ['id' => '\d+', 'rateId' => '\d+'])]
|
|
public function deleteRateAction(Customer $customer, #[MapEntity(mapping: ['rateId' => 'id'])] CustomerRate $rate): Response
|
|
{
|
|
if ($rate->getCustomer() !== $customer) {
|
|
throw $this->createNotFoundException();
|
|
}
|
|
|
|
$this->customerRateRepository->deleteRate($rate);
|
|
|
|
$view = new View(null, Response::HTTP_NO_CONTENT);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
/**
|
|
* Add rate for customer
|
|
*/
|
|
#[IsGranted('edit', 'customer')]
|
|
#[OA\Post(responses: [new OA\Response(response: 200, description: 'Returns the new created rate', content: new OA\JsonContent(ref: '#/components/schemas/CustomerRate'))])]
|
|
#[OA\Parameter(name: 'id', in: 'path', description: 'The customer to add the rate for', required: true)]
|
|
#[OA\RequestBody(required: true, content: new OA\JsonContent(ref: '#/components/schemas/CustomerRateForm'))]
|
|
#[Route(methods: ['POST'], path: '/{id}/rates', name: 'post_customer_rate', requirements: ['id' => '\d+'])]
|
|
public function postRateAction(Customer $customer, Request $request): Response
|
|
{
|
|
$rate = new CustomerRate();
|
|
$rate->setCustomer($customer);
|
|
|
|
$form = $this->createForm(CustomerRateApiForm::class, $rate, [
|
|
'method' => 'POST',
|
|
]);
|
|
|
|
$form->setData($rate);
|
|
$form->submit($request->request->all(), false);
|
|
|
|
if (false === $form->isValid()) {
|
|
$view = new View($form, Response::HTTP_OK);
|
|
$view->getContext()->setGroups(self::GROUPS_RATE);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
|
|
$this->customerRateRepository->saveRate($rate);
|
|
|
|
$view = new View($rate, Response::HTTP_OK);
|
|
$view->getContext()->setGroups(self::GROUPS_RATE);
|
|
|
|
return $this->viewHandler->handle($view);
|
|
}
|
|
}
|