Merge pull request #780 from owlchester/bulk-relation-creation

Bulk Relation Creation

app/Http/Controllers/Api/v1/EntityRelationApiController.php

@@ -6,10 +6,18 @@
 use App\Models\Entity;
 use App\Http\Requests\StoreRelation as Request;
 use App\Http\Resources\RelationResource as Resource;
+use App\Services\Entity\RelationService;
 use App\Models\Relation;
 
 class EntityRelationApiController extends ApiController
 {
+    protected RelationService $relationService;
+
+    public function __construct(RelationService $relationService)
+    {
+        $this->relationService = $relationService;
+    }
+
     /**
      * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
      * @throws \Illuminate\Auth\Access\AuthorizationException
@@ -32,18 +40,17 @@ public function show(Campaign $campaign, Entity $entity, Relation $relation)
     }
 
     /**
-     * @return Resource
+     * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function store(Request $request, Campaign $campaign, Entity $entity)
     {
         $this->authorize('access', $campaign);
         $this->authorize('update', $entity->child);
 
-        $data = $request->all();
-        $data['campaign_id'] = $campaign->id;
-        $model = Relation::create($data);
-        return new Resource($model);
+        $this->relationService->campaign($campaign)->createRelations($request);
+
+        return Resource::collection($entity->relationships()->has('target')->whereIn('target_id', $this->relationService->getEntities())->paginate());
     }
 
     /**

app/Http/Controllers/Entity/RelationController.php

@@ -9,17 +9,20 @@
 use App\Models\Entity;
 use App\Models\Relation;
 use App\Services\Entity\ConnectionService;
+use App\Services\Entity\RelationService;
 use App\Traits\GuestAuthTrait;
 
 class RelationController extends Controller
 {
     use GuestAuthTrait;
 
     protected ConnectionService $connectionService;
+    protected RelationService $relationService;
 
-    public function __construct(ConnectionService $connectionService)
+    public function __construct(ConnectionService $connectionService, RelationService $relationService)
     {
         $this->connectionService = $connectionService;
+        $this->relationService = $relationService;
     }
 
     public function index(Campaign $campaign, Entity $entity)
@@ -110,17 +113,7 @@ public function store(StoreRelation $request, Campaign $campaign, Entity $entity
             return response()->json(['success' => true]);
         }
 
-        $data = $request->only([
-            'owner_id', 'target_id', 'attitude', 'relation', 'colour', 'is_pinned', 'two_way', 'visibility_id'
-        ]);
-        $data['campaign_id'] = $entity->campaign_id;
-
-        $relation = new Relation();
-        $relation = $relation->create($data);
-
-        if ($request->has('two_way')) {
-            $relation->createMirror();
-        }
+        $this->relationService->campaign($campaign)->createRelations($request);
 
         $mode = $this->getModeOption(true);
         $redirect = [$campaign, $entity];
@@ -130,9 +123,9 @@ public function store(StoreRelation $request, Campaign $campaign, Entity $entity
 
         return redirect()
             ->route('entities.relations.index', $redirect)
-            ->with('success', trans('entities/relations.create.success', [
-                'target' => $relation->target->name,
-                'entity' => $entity->name
+            ->with('success', trans_choice('entities/relations.create.success_bulk', $count, [
+                'entity' => $entity->name,
+                'count' => $this->relationService->getCount(),
             ]));
     }
 

app/Http/Controllers/RelationController.php

@@ -5,11 +5,14 @@
 use App\Datagrids\Actions\RelationDatagridActions;
 use App\Datagrids\Filters\RelationFilter;
 use App\Http\Requests\StoreRelation;
+use App\Services\Entity\RelationService;
 use App\Models\Campaign;
 use App\Models\Relation;
 
 class RelationController extends CrudController
 {
+    protected RelationService $relationService;
+
     protected string $view = 'relations';
     protected string $route = 'relations';
     protected $langKey = 'entities/relations';
@@ -36,12 +39,13 @@ class RelationController extends CrudController
 
     public string $titleKey;
 
-    public function __construct()
+    public function __construct(RelationService $relationService)
     {
         parent::__construct();
         $this->middleware('auth');
 
         $this->titleKey = __('sidebar.relations');
+        $this->relationService = $relationService;
     }
 
     /**
@@ -77,23 +81,16 @@ public function store(StoreRelation $request, Campaign $campaign)
         }
 
         try {
-            $data = $request->all();
-            $data['campaign_id'] = $campaign->id;
-
-            $model = new $this->model();
-            /** @var Relation $new */
-            $new = $model->create($data);
-
-            if ($request->has('two_way')) {
-                $new->createMirror();
-            }
+            $this->relationService->campaign($campaign)->createRelations($request);
+            $new = $this->relationService->getNew();
+            $count = $this->relationService->getCount();
 
-            $success = __($this->langKey . '.create.success', [
-                'target' => $new->target->name,
+            $success = trans_choice($this->langKey . '.create.success_bulk', $count, [
                 'entity' => link_to(
                     $new->owner->url(),
                     $new->owner->name
-                )
+                ),
+                'count' => $count,
             ]);
             session()->flash('success_raw', $success);
 

app/Http/Requests/StoreRelation.php

@@ -28,7 +28,12 @@ public function rules()
     {
         return $this->clean([
             'owner_id' => 'required|exists:entities,id',
-            'target_id' => 'required|exists:entities,id|different:owner_id',
+            'targets' => 'required_without:target_id',
+            // @phpstan-ignore-next-line
+            'targets' => [
+                '*' => 'exists:entities,id',
+            ],
+            'target_id' => 'required_without:targets|exists:entities,id|different:owner_id',
             'relation' => 'required|max:255',
             'visibility_id' => 'nullable|exists:visibilities,id',
             'attitude' => 'min:-100|max:100',

app/Services/Entity/RelationService.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Services\Entity;
+
+use App\Http\Requests\StoreRelation;
+use App\Models\Relation;
+use App\Traits\CampaignAware;
+
+class RelationService
+{
+    use CampaignAware;
+
+    protected array $entities;
+    protected Relation $new;
+    protected int $count;
+
+    /**
+     */
+    public function createRelations(StoreRelation $request): self
+    {
+        $this->count = 0;
+        $data = $request->only([
+            'owner_id', 'attitude', 'relation', 'colour', 'is_pinned', 'two_way', 'visibility_id'
+        ]);
+        $data['campaign_id'] = $this->campaign->id;
+
+        if ($request->has('targets')) {
+            $this->entities = $request->get('targets');
+        } else {
+            $this->entities = [$request->get('target_id')];
+        }
+        foreach ($this->entities as $entity_id) {
+            $data['target_id'] = $entity_id;
+            $relation = new Relation();
+            $relation = $relation->create($data);
+            $this->count++;
+            if (!isset($new)) {
+                $new = $relation;
+            }
+            if ($request->has('two_way')) {
+                $relation->createMirror();
+                $this->count++;
+            }
+        }
+        $this->new = $new;
+
+        return $this;
+    }
+
+    public function getEntities(): array
+    {
+        return $this->entities;
+    }
+
+    public function getNew(): Relation
+    {
+        return $this->new;
+    }
+
+    public function getCount(): int
+    {
+        return $this->count;
+    }
+}

lang/en/entities/relations.php

@@ -30,9 +30,9 @@
         'timeline_element'  => 'Timeline element',
     ],
     'create'            => [
-        'new_title' => 'New connection',
-        'success'   => 'Connection :target added to :entity.',
-        'title'     => 'New connection for :name',
+        'new_title'     => 'New connection',
+        'success_bulk'  => '{1} Added :count connection to :entity.|[2,*] Added :count connections to :entity.',
+        'title'         => 'New connection for :name',
     ],
     'delete_mirrored'   => [
         'helper'    => 'This connection is mirrored on the target entity. Select this option to also remove the mirrored connection.',

resources/api-docs/1.0/relations.md

@@ -85,7 +85,8 @@ To create a relation, use the following endpoint.
 | :- |   :-   |  :-  |
 | `relation` | `string` (Required, max 255) | Description of the relation |
 | `owner_id` | `int` (Required) | The relation's entity |
-| `target_id` | `int` (Required) | The relation's target entity |
+| `target_id` | `int` (Required if `targets` is not set) | The relation's target entity |
+| `targets` | `array` (Required if `target_id` is not set) | An array of the relation's target entities |
 | `attitude` | `int` | -100 to 100 |
 | `colour` | `string` | Hex colour of the attitude (with or without the `#`) |
 | `two_way` | `boolean` | If set, will duplicate the relation but in the other direction |
@@ -94,7 +95,7 @@ To create a relation, use the following endpoint.
 
 ### Results
 
-> {success} Code 200 with JSON body of the new relation.
+> {success} Code 200 with JSON body of the new relations.
 
 
 <a name="update-relation"></a>

resources/views/components/forms/foreign.blade.php

@@ -10,9 +10,9 @@
         <div class="join w-full">
     @endif
 
-    <select
+    <select 
             @if ($multiple) multiple="multiple" @endif
-            name="{{ $name }}"
+            name="{{ $name }}" 
             id="{{ $id }}"
             class="w-full select2 join-item"
             style="width: 100%"

resources/views/cruds/fields/target.blade.php

@@ -2,10 +2,23 @@
 $required = !isset($bulk);
 $preset = $target ?? null;
 @endphp
-
-@include('cruds.fields.entity', [
-    'name' => 'target_id',
-    'label' => __('entities/relations.fields.target'),
-    'allowClear' => false,
-    'route' => null,
-])
+@if(empty($relation) && $required)
+    <x-forms.foreign
+        field="targets"
+        :required="true"
+        label="entities/relations.fields.target"
+        :multiple="true"
+        name="targets[]"
+        id="targets[]"
+        :campaign="$campaign"
+        :route="route('search.entities-with-relations', [$campaign])"
+    >
+    </x-forms.foreign>
+@else
+    @include('cruds.fields.entity', [
+        'name' => 'target_id',
+        'label' => __('entities/relations.fields.target'),
+        'allowClear' => false,
+        'route' => null,
+    ])
+@endif

resources/views/entities/pages/relations/_form.blade.php

@@ -1,6 +1,19 @@
 {{ csrf_field() }}
 
 <x-grid>
+@if(empty($relation))
+    <x-forms.foreign
+        field="targets"
+        :required="true"
+        label="entities/relations.fields.target"
+        :multiple="true"
+        name="targets[]"
+        id="targets[]"
+        :campaign="$campaign"
+        :route="route('search.entities-with-relations', [$campaign])"
+    >
+    </x-forms.foreign>
+@else
     @include('cruds.fields.entity', [
         'name' => 'target_id',
         'required' => true,
@@ -10,6 +23,7 @@
         'dropdownParent' => request()->ajax() ? '#primary-dialog' : null,
         'allowClear' => false,
     ])
+@endif
     <x-forms.field field="relation" :required="true" :label="__('entities/relations.fields.relation')">
         {!! Form::text('relation', null, ['placeholder' => __('entities/relations.placeholders.relation'), 'class' => '', 'maxlength' => 191, 'required']) !!}
     </x-forms.field>