[0.11] Extend entity contextmenu with options to add above/below

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.11 - 
+### Added
+- _Add Entity Above_ and _Add Entity Below_ to the Contextmenu in the entity tree
+
 ## 0.10.1
 ### Fixed
 - Frontend errors due to wrong dayjs import

app/Entity.php

@@ -52,9 +52,10 @@ class Entity extends Model implements Searchable {
     ];
 
     const rules = [
-        'name'              => 'required|string',
-        'entity_type_id'   => 'required|integer|exists:entity_types,id',
-        'root_entity_id'   => 'integer|exists:entities,id',
+        'name'           => 'required|string',
+        'entity_type_id' => 'required|integer|exists:entity_types,id',
+        'root_entity_id' => 'integer|exists:entities,id',
+        'rank'           => 'integer|min:1',
     ];
 
     const patchRules = [
@@ -84,8 +85,8 @@ public function getAllMetadata() {
             'editors' => $this->editors,
             'metadata' => $this->metadata,
         ];
-    }  
-    
+    }
+
     public static function getSearchCols(): array {
         return array_keys(self::searchCols);
     }
@@ -120,7 +121,7 @@ public static function getFromPath($path, $delimiter = "\\\\"): ?int {
         }
     }
 
-    public static function create($fields, $entityTypeId, $user, $rootEntityId = null) {
+    public static function create($fields, $entityTypeId, $user, $rootEntityId = null, $rank = null) {
         $isChild = isset($rootEntityId);
         if($isChild) {
             $parentCtid = self::find($rootEntityId)->entity_type_id;
@@ -144,14 +145,27 @@ public static function create($fields, $entityTypeId, $user, $rootEntityId = nul
         }
 
         $entity = new self();
-        $rank;
         if($isChild) {
-            $rank = self::where('root_entity_id', $rootEntityId)->max('rank') + 1;
+            if(!isset($rank)) {
+                $rank = self::where('root_entity_id', $rootEntityId)->max('rank') + 1;
+            } else {
+                $nextSiblings = self::where('root_entity_id', $rootEntityId)->where('rank', '>=', $rank)->get();
+            }
             $entity->root_entity_id = $rootEntityId;
         } else {
-            $rank = self::whereNull('root_entity_id')->max('rank') + 1;
+            if(!isset($rank)) {
+                $rank = self::whereNull('root_entity_id')->max('rank') + 1;
+            } else {
+                $nextSiblings = self::whereNull('root_entity_id')->where('rank', '>=', $rank)->get();
+            }
         }
         $entity->rank = $rank;
+        if(isset($nextSiblings) && count($nextSiblings) > 0) {
+            foreach($nextSiblings as $sibling) {
+                $sibling->rank = $sibling->rank + 1;
+                $sibling->saveQuietly();
+            }
+        }
 
         foreach($fields as $key => $value) {
             $entity->{$key} = $value;
@@ -180,35 +194,34 @@ public static function getEntitiesByParent($id = null) {
         }
         return $entities->orderBy('rank')->get();
     }
-    
+
     private function moveOrFail(int | null $parentId) {
-
         if(isset($parentId)) {
             if($parentId == $this->id) {
                 throw new \Exception('Cannot move entity to itself.');
             }
-            
+
             $parentEntity = Entity::findOrFail($parentId);
             $parentEntityType = $parentEntity->entity_type;
-            
+
             if(!$parentEntityType->sub_entity_types->contains($this->entity_type_id)) {
                 throw new \Exception('This type is not an allowed sub-type.');
             }
-            
+
             $this->root_entity_id = $parentId;
             $query = self::where('root_entity_id', $parentId);
         } else {
             if(!$this->entity_type->is_root) {
                 throw new \Exception('This type is not an allowed root-type.');
             }
-            
+
             $this->root_entity_id = null;
             $query = self::whereNull('root_entity_id');
         }
         return $query;
     }
 
-    public static function patchRanks($rank, $id, $parent, $user) { 
+    public static function patchRanks($rank, $id, $parent, $user) {
         $entity = Entity::find($id);
         $oldRank = $entity->rank;
         $entity->rank = $rank;
@@ -227,7 +240,7 @@ public static function patchRanks($rank, $id, $parent, $user) {
             $oc->rank--;
             $oc->saveQuietly();
         }
-        
+
         try{
             $query = $entity->moveOrFail($parent);
         }catch(\Exception $e) {

app/Http/Controllers/EntityController.php

@@ -372,8 +372,9 @@ public function addEntity(Request $request) {
         $fields = $request->only(array_keys(Entity::rules));
         $etid = $request->get('entity_type_id');
         $reid = $request->get('root_entity_id');
+        $rank = $request->get('rank');
 
-        $res = Entity::create($fields, $etid, $user, $reid);
+        $res = Entity::create($fields, $etid, $user, $reid, $rank);
 
         if($res['type'] === 'entity') {
             return response()->json($res['entity'], 201);
@@ -493,7 +494,6 @@ public function importData(Request $request) {
         $entityTypeId = trim($data['entity_type_id']);
         $attributesMapping = array_map(fn ($col) => trim($col), $data['attributes']);
 
-
         $headerRow = null;
         $hasParent = false;
         $attributeIdToColumnIdxMapping = [];
@@ -506,7 +506,6 @@ public function importData(Request $request) {
         $parentIdx = null;
         $nameIdx = null;
 
-
         // Getting headers
         if(($row = fgetcsv($handle, 0, $metadata['delimiter'])) !== false) {
             $row = sp_trim_array($row);
@@ -656,7 +655,6 @@ public function importData(Request $request) {
     }
 
     function createImportedEntity($entityName, ?string $rootEntityPath, $entityTypeId, $user) {
-
         $rootEntityId = null;
         if(isset($rootEntityPath)) {
             try {

resources/js/api.js

@@ -384,6 +384,9 @@ export async function addEntity(entity) {
     if(!!entity.parent_id) {
         data.root_entity_id = entity.parent_id;
     }
+    if(!!entity.rank) {
+        data.rank = entity.rank;
+    }
     return $httpQueue.add(
         () => http.post(`/entity`, data).then(response => response.data)
     );

resources/js/bootstrap/font.js

@@ -215,6 +215,8 @@ import {
     faTimes,
     faTrash,
     faTrashRestore,
+    faTurnDown,
+    faTurnUp,
     faUnderline,
     faUndo,
     faUndoAlt,
@@ -430,6 +432,8 @@ library.add(
     faTimes,
     faTrash,
     faTrashRestore,
+    faTurnDown,
+    faTurnUp,
     faUnderline,
     faUndo,
     faUndoAlt,

resources/js/bootstrap/stores/entity.js

@@ -236,7 +236,15 @@ export const useEntityStore = defineStore('entity', {
                         this.tree.splice(idx, 1, node);
                     }
                 } else {
-                    this.tree.push(node);
+                    if(this.tree.length == 0 || node.rank > this.tree.at(-1).rank) {
+                        this.tree.push(node);
+                    } else {
+                        const idx = this.tree.findIndex(c => c.rank == node.rank);
+                        this.tree.splice(idx, 0, node);
+                        for(let i=idx+1; i<this.tree.length; i++) {
+                            this.tree[i].rank++;
+                        }
+                    }
                 }
             } else {
                 const doCount = !node?.already_existing;
@@ -250,7 +258,15 @@ export const useEntityStore = defineStore('entity', {
                                 parent.children.splice(idx, 1, node);
                             }
                         } else {
-                            parent.children.push(node);
+                            if(node.rank > parent.children.at(-1).rank) {
+                                parent.children.push(node);
+                            } else {
+                                const idx = parent.children.findIndex(c => c.rank == node.rank);
+                                parent.children.splice(idx, 0, node);
+                                for(let i=idx+1; i<parent.children.length; i++) {
+                                    parent.children[i].rank++;
+                                }
+                            }
                         }
                     }
                     if(doCount) {

resources/js/components/tree/TreeMenu.vue

@@ -22,6 +22,32 @@
                 </span>
             </a>
         </li>
+        <li>
+            <a
+                class="dropdown-item"
+                href="#"
+                @click.stop.prevent="addEntity('above')"
+                @dblclick.stop.prevent=""
+            >
+                <i class="fas fa-fw fa-turn-up text-success" />
+                <span class="ms-2">
+                    {{ t('main.entity.tree.contextmenu.add_above') }}
+                </span>
+            </a>
+        </li>
+        <li>
+            <a
+                class="dropdown-item"
+                href="#"
+                @click.stop.prevent="addEntity('below')"
+                @dblclick.stop.prevent=""
+            >
+                <i class="fas fa-fw fa-turn-down text-success" />
+                <span class="ms-2">
+                    {{ t('main.entity.tree.contextmenu.add_below') }}
+                </span>
+            </a>
+        </li>
         <li>
             <a
                 class="dropdown-item"
@@ -109,8 +135,16 @@
                 context.emit('close');
             });
 
-            const addEntity = _ => {
-                showAddEntity(props.data);
+            const addEntity = where => {
+                if(where == 'above') {
+                    const parent = entityStore.getEntity(props.data.root_entity_id);
+                    showAddEntity(parent, null, props.data.rank);
+                } else if(where == 'below') {
+                    const parent = entityStore.getEntity(props.data.root_entity_id);
+                    showAddEntity(parent, null, props.data.rank + 1);
+                } else {
+                    showAddEntity(props.data);
+                }
             };
             const duplicateEntity = _ => {
                 duplicateEntityApi(props.data).then(data => {

resources/js/helpers/modal.js

@@ -529,7 +529,7 @@ export function showLiteratureInfo(id, options) {
     modal.open();
 }
 
-export function showAddEntity(parent = null, onAdded) {
+export function showAddEntity(parent = null, onAdded, rank = -1) {
     const uid = `AddEntity-${getTs()}`;
     const modal = useModal({
         component: AddEntity,
@@ -545,6 +545,9 @@ export function showAddEntity(parent = null, onAdded) {
                     parent_id: entity.parent_id,
                     name: entity.name,
                 };
+                if(rank != -1) {
+                    entityData.rank = rank;
+                }
 
                 useEntityStore().create(entityData).then(node => {
                     if(!!onAdded) {

resources/js/i18n/de.json

@@ -481,6 +481,8 @@
                 "add": "Neue Top-Level Entität hinzufügen",
                 "contextmenu": {
                     "add": "Unterentität hinzufügen",
+                    "add_above": "Entität darüber hinzufügen",
+                    "add_below": "Entität darunter hinzufügen",
                     "duplicate": "Duplikat erzeugen",
                     "move": "Im Baum verschieben",
                     "delete": "Entität löschen"

resources/js/i18n/en.json

@@ -481,6 +481,8 @@
                 "add": "Add new Top-Level-Entity",
                 "contextmenu": {
                     "add": "Add Sub-Entity",
+                    "add_above": "Add Entity Above",
+                    "add_below": "Add Entity Below",
                     "duplicate": "Create Duplicate",
                     "move": "Move in Tree",
                     "delete": "Delete Entity"