mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-28 12:40:08 +02:00
Added possibility to add a change comment to changes via the API
This commit is contained in:
parent
915444b5da
commit
d2144a1fed
2 changed files with 70 additions and 1 deletions
|
@ -89,3 +89,10 @@ For example if you only want to get the name and the description of a part, you
|
|||
It is also possible to use this filters on list endpoints (get collection), to only get a subset of the properties of all entities in the collection.
|
||||
|
||||
See [API Platform docs](https://api-platform.com/docs/core/filters/#property-filter) for more infos.
|
||||
|
||||
## Change comment
|
||||
|
||||
Similar to the changes using Part-DB web interface, you can add a change comment to every change you make via the API, which will be
|
||||
visible in the log of the entity.
|
||||
|
||||
You can pass the text for this via the `_comment` query parameter (beware the proper encoding). For example `/api/parts/123?_comment=This%20is%20a%20change%20comment`.
|
62
src/EventListener/AddEditCommentRequestListener.php
Normal file
62
src/EventListener/AddEditCommentRequestListener.php
Normal file
|
@ -0,0 +1,62 @@
|
|||
<?php
|
||||
/*
|
||||
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||
*
|
||||
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
|
||||
namespace App\EventListener;
|
||||
|
||||
use App\Services\LogSystem\EventCommentHelper;
|
||||
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
|
||||
use Symfony\Component\HttpKernel\Event\RequestEvent;
|
||||
|
||||
#[AsEventListener()]
|
||||
class AddEditCommentRequestListener
|
||||
{
|
||||
public function __construct(private readonly EventCommentHelper $helper)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
public function __invoke(RequestEvent $event)
|
||||
{
|
||||
if (!$event->isMainRequest()) {
|
||||
return;
|
||||
}
|
||||
$request = $event->getRequest();
|
||||
|
||||
//Do not add comment if the request is a GET request
|
||||
if ($request->isMethod('GET')) {
|
||||
return;
|
||||
}
|
||||
|
||||
//Check if the user tries to access a /api/ endpoint, if not skip
|
||||
if (!str_contains($request->getPathInfo(), '/api/')) {
|
||||
return;
|
||||
}
|
||||
|
||||
//Extract the comment from the query parameter
|
||||
$comment = $request->query->getString('_comment', '');
|
||||
|
||||
if ($comment !== '') {
|
||||
$this->helper->setMessage($comment);
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue