Add application API and OpenAPI docs
linter / quality (pull_request) Successful in 1m18s
tests / ci (8.4) (pull_request) Successful in 1m28s

This commit is contained in:
2026-04-20 13:22:56 +02:00
parent 70d760e3a6
commit 8b25421e7c
80 changed files with 6908 additions and 1277 deletions
@@ -0,0 +1,40 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketPriority;
use Illuminate\Support\Facades\DB;
class DeleteProjectTicketPriority
{
use ReordersProjectMetadata;
/**
* @return array{deleted: bool, deleted_name: string, message: string}
*/
public function handle(Project $project, TicketPriority $ticketPriority): array
{
if ($project->ticketPriorities()->count() === 1) {
return [
'deleted' => false,
'deleted_name' => $ticketPriority->name,
'message' => 'The last ticket priority cannot be deleted.',
];
}
$deletedName = $ticketPriority->name;
DB::transaction(function () use ($project, $ticketPriority): void {
$ticketPriority->delete();
$this->persistOrderedModels($project->ticketPriorities()->get()->values());
});
return [
'deleted' => true,
'deleted_name' => $deletedName,
'message' => "{$deletedName} priority was removed.",
];
}
}
@@ -0,0 +1,81 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Actions\Tickets\CreateTicketWorklogEntry;
use App\Enums\TicketWorklogEntryType;
use App\Models\Project;
use App\Models\Ticket;
use App\Models\TicketType;
use App\Models\User;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class DeleteProjectTicketType
{
use ReordersProjectMetadata;
public function __construct(
private readonly CreateTicketWorklogEntry $createTicketWorklogEntry,
) {}
/**
* @param array{replacement_ticket_type_id?: int|null} $validated
* @return array{deleted: bool, deleted_name: string, message: string}
*/
public function handle(Project $project, TicketType $ticketType, User $actor, array $validated): array
{
if ($project->ticketTypes()->count() === 1) {
return [
'deleted' => false,
'deleted_name' => $ticketType->name,
'message' => 'The last ticket type cannot be deleted.',
];
}
$deletedName = $ticketType->name;
DB::transaction(function () use ($actor, $deletedName, $project, $ticketType, $validated): void {
$replacementTicketTypeId = Arr::get($validated, 'replacement_ticket_type_id');
if ($replacementTicketTypeId !== null) {
$replacementTicketType = $project->ticketTypes()
->findOrFail($replacementTicketTypeId);
Ticket::query()
->where('project_id', $project->id)
->where('ticket_type_id', $ticketType->id)
->with(['ticketType'])
->get()
->each(function (Ticket $ticket) use ($actor, $deletedName, $replacementTicketType): void {
$ticket->update([
'ticket_type_id' => $replacementTicketType->id,
]);
$this->createTicketWorklogEntry->handle(
$ticket->fresh(),
$actor,
TicketWorklogEntryType::Updated,
"Updated type because {$deletedName} type was deleted.",
[
'ticket_type' => [
'from' => $deletedName,
'to' => $replacementTicketType->name,
],
],
);
});
}
$ticketType->delete();
$this->persistOrderedModels($project->ticketTypes()->get()->values());
});
return [
'deleted' => true,
'deleted_name' => $deletedName,
'message' => "{$deletedName} type was removed.",
];
}
}
@@ -0,0 +1,25 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketFieldDefinition;
use Illuminate\Support\Facades\DB;
class DeleteTicketFieldDefinition
{
use ReordersProjectMetadata;
public function handle(Project $project, TicketFieldDefinition $ticketFieldDefinition): string
{
$deletedLabel = $ticketFieldDefinition->label;
DB::transaction(function () use ($project, $ticketFieldDefinition): void {
$ticketFieldDefinition->delete();
$this->persistOrderedModels($project->ticketFieldDefinitions()->get()->values());
});
return $deletedLabel;
}
}
@@ -0,0 +1,25 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketLinkType;
use Illuminate\Support\Facades\DB;
class DeleteTicketLinkType
{
use ReordersProjectMetadata;
public function handle(Project $project, TicketLinkType $ticketLinkType): string
{
$deletedLabel = $ticketLinkType->label;
DB::transaction(function () use ($project, $ticketLinkType): void {
$ticketLinkType->delete();
$this->persistOrderedModels($project->ticketLinkTypes()->get()->values());
});
return $deletedLabel;
}
}
@@ -0,0 +1,41 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
trait ReordersProjectMetadata
{
/**
* @param Collection<int, Model> $models
*/
private function persistOrderedModels(Collection $models): void
{
$temporaryOffset = ((int) $models->max('position')) + $models->count() + 1;
$models->each(function (Model $model, int $index) use ($temporaryOffset): void {
$model->forceFill([
'position' => $temporaryOffset + $index,
])->saveQuietly();
});
$models->each(function (Model $model, int $index): void {
$model->forceFill([
'position' => $index + 1,
])->saveQuietly();
});
}
/**
* @param Collection<int, Model> $existingModels
*/
private function reorderModels(Collection $existingModels, Model $movingModel, int $desiredPosition): void
{
$insertAt = max(0, min($desiredPosition - 1, $existingModels->count()));
$existingModels->splice($insertAt, 0, [$movingModel]);
$this->persistOrderedModels($existingModels->values());
}
}
@@ -0,0 +1,37 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketPriority;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class StoreProjectTicketPriority
{
use ReordersProjectMetadata;
/**
* @param array{name: string, position?: int|null} $validated
*/
public function handle(Project $project, array $validated): TicketPriority
{
$name = Arr::get($validated, 'name');
$position = Arr::get($validated, 'position');
return DB::transaction(function () use ($project, $name, $position): TicketPriority {
$ticketPriority = $project->ticketPriorities()->create([
'name' => $name,
'position' => $project->ticketPriorities()->count() + 1,
]);
$this->reorderModels(
$project->ticketPriorities()->whereKeyNot($ticketPriority->id)->get()->values(),
$ticketPriority,
$position ?? $project->ticketPriorities()->count(),
);
return $ticketPriority;
});
}
}
@@ -0,0 +1,35 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketType;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class StoreProjectTicketType
{
use ReordersProjectMetadata;
/**
* @param array{is_parent?: bool|null, name: string, position?: int|null} $validated
*/
public function handle(Project $project, array $validated): TicketType
{
return DB::transaction(function () use ($project, $validated): TicketType {
$ticketType = $project->ticketTypes()->create([
'name' => Arr::get($validated, 'name'),
'position' => $project->ticketTypes()->count() + 1,
'is_parent' => Arr::get($validated, 'is_parent', false),
]);
$this->reorderModels(
$project->ticketTypes()->whereKeyNot($ticketType->id)->get()->values(),
$ticketType,
Arr::get($validated, 'position') ?? $project->ticketTypes()->count(),
);
return $ticketType;
});
}
}
@@ -0,0 +1,35 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketFieldDefinition;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class StoreTicketFieldDefinition
{
use ReordersProjectMetadata;
/**
* @param array{field_type: string, label: string, position?: int|null} $validated
*/
public function handle(Project $project, array $validated): TicketFieldDefinition
{
return DB::transaction(function () use ($project, $validated): TicketFieldDefinition {
$ticketFieldDefinition = $project->ticketFieldDefinitions()->create([
'field_type' => Arr::get($validated, 'field_type'),
'label' => Arr::get($validated, 'label'),
'position' => $project->ticketFieldDefinitions()->count() + 1,
]);
$this->reorderModels(
$project->ticketFieldDefinitions()->whereKeyNot($ticketFieldDefinition->id)->get()->values(),
$ticketFieldDefinition,
Arr::get($validated, 'position') ?? $project->ticketFieldDefinitions()->count(),
);
return $ticketFieldDefinition;
});
}
}
@@ -0,0 +1,37 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketLinkType;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class StoreTicketLinkType
{
use ReordersProjectMetadata;
/**
* @param array{name: string, position?: int|null} $validated
*/
public function handle(Project $project, array $validated): TicketLinkType
{
$name = Arr::get($validated, 'name');
$position = Arr::get($validated, 'position');
return DB::transaction(function () use ($project, $position, $name): TicketLinkType {
$ticketLinkType = $project->ticketLinkTypes()->create([
'label' => $name,
'position' => $project->ticketLinkTypes()->count() + 1,
]);
$this->reorderModels(
$project->ticketLinkTypes()->whereKeyNot($ticketLinkType->id)->get()->values(),
$ticketLinkType,
$position ?? $project->ticketLinkTypes()->count(),
);
return $ticketLinkType;
});
}
}
@@ -0,0 +1,22 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use Illuminate\Support\Arr;
class UpdateProjectTicketMetadataSettings
{
/**
* @param array{show_author?: bool|null, show_story_points?: bool|null} $validated
*/
public function handle(Project $project, array $validated): Project
{
$project->update([
'show_author' => Arr::get($validated, 'show_author', false),
'show_story_points' => Arr::get($validated, 'show_story_points', false),
]);
return $project->fresh();
}
}
@@ -0,0 +1,36 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketPriority;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class UpdateProjectTicketPriority
{
use ReordersProjectMetadata;
/**
* @param array{name: string, position: int} $validated
*/
public function handle(Project $project, TicketPriority $ticketPriority, array $validated): TicketPriority
{
$name = Arr::get($validated, 'name');
$position = Arr::get($validated, 'position');
DB::transaction(function () use ($project, $name, $position, $ticketPriority): void {
$ticketPriority->update([
'name' => $name,
]);
$this->reorderModels(
$project->ticketPriorities()->whereKeyNot($ticketPriority->id)->get()->values(),
$ticketPriority,
$position,
);
});
return $ticketPriority->fresh();
}
}
@@ -0,0 +1,33 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketType;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class UpdateProjectTicketType
{
use ReordersProjectMetadata;
/**
* @param array{name: string, position: int} $validated
*/
public function handle(Project $project, TicketType $ticketType, array $validated): TicketType
{
DB::transaction(function () use ($project, $validated, $ticketType): void {
$ticketType->update([
'name' => Arr::get($validated, 'name'),
]);
$this->reorderModels(
$project->ticketTypes()->whereKeyNot($ticketType->id)->get()->values(),
$ticketType,
Arr::get($validated, 'position'),
);
});
return $ticketType->fresh();
}
}
@@ -0,0 +1,34 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketFieldDefinition;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class UpdateTicketFieldDefinition
{
use ReordersProjectMetadata;
/**
* @param array{field_type: string, label: string, position: int} $validated
*/
public function handle(Project $project, TicketFieldDefinition $ticketFieldDefinition, array $validated): TicketFieldDefinition
{
DB::transaction(function () use ($project, $ticketFieldDefinition, $validated): void {
$ticketFieldDefinition->update([
'field_type' => Arr::get($validated, 'field_type'),
'label' => Arr::get($validated, 'label'),
]);
$this->reorderModels(
$project->ticketFieldDefinitions()->whereKeyNot($ticketFieldDefinition->id)->get()->values(),
$ticketFieldDefinition,
Arr::get($validated, 'position'),
);
});
return $ticketFieldDefinition->fresh();
}
}
@@ -0,0 +1,36 @@
<?php
namespace App\Actions\ProjectTicketMetadata;
use App\Models\Project;
use App\Models\TicketLinkType;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class UpdateTicketLinkType
{
use ReordersProjectMetadata;
/**
* @param array{name: string, position: int} $validated
*/
public function handle(Project $project, TicketLinkType $ticketLinkType, array $validated): TicketLinkType
{
$name = Arr::get($validated, 'name');
$position = Arr::get($validated, 'position');
DB::transaction(function () use ($project, $name, $position, $ticketLinkType): void {
$ticketLinkType->update([
'label' => $name,
]);
$this->reorderModels(
$project->ticketLinkTypes()->whereKeyNot($ticketLinkType->id)->get()->values(),
$ticketLinkType,
$position,
);
});
return $ticketLinkType->fresh();
}
}