ZIP Imports: Added API examples, finished testing

[bookstack] / app / Entities / Repos / ChapterRepo.php

diff --git a/app/Entities/Repos/ChapterRepo.php b/app/Entities/Repos/ChapterRepo.php
index d56874e0d54a9b647ce59f4a84add65fa793f302..6503e63cfafc5912a886131ab089b169358ecbeb 100644 (file)
--- a/app/Entities/Repos/ChapterRepo.php
+++ b/app/Entities/Repos/ChapterRepo.php
@@ -1,42 +1,26 @@
-<?php namespace BookStack\Entities\Repos;
+<?php

 
 

-use BookStack\Actions\ActivityType;
+namespace BookStack\Entities\Repos;
+
+use BookStack\Activity\ActivityType;

 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Chapter;

+use BookStack\Entities\Queries\EntityQueries;

 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\TrashCan;
 use BookStack\Exceptions\MoveOperationException;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\TrashCan;
 use BookStack\Exceptions\MoveOperationException;

-use BookStack\Exceptions\NotFoundException;
+use BookStack\Exceptions\PermissionsException;

 use BookStack\Facades\Activity;
 use BookStack\Facades\Activity;

+use BookStack\Util\DatabaseTransaction;

 use Exception;
 use Exception;

-use Illuminate\Support\Collection;

 
 class ChapterRepo
 {
 
 class ChapterRepo
 {

-
-    protected $baseRepo;
-
-    /**
-     * ChapterRepo constructor.
-     */
-    public function __construct(BaseRepo $baseRepo)
-    {
-        $this->baseRepo = $baseRepo;
-    }
-
-    /**
-     * Get a chapter via the slug.
-     * @throws NotFoundException
-     */
-    public function getBySlug(string $bookSlug, string $chapterSlug): Chapter
-    {
-        $chapter = Chapter::visible()->whereSlugs($bookSlug, $chapterSlug)->first();
-
-        if ($chapter === null) {
-            throw new NotFoundException(trans('errors.chapter_not_found'));
-        }
-
-        return $chapter;
+    public function __construct(
+        protected BaseRepo $baseRepo,
+        protected EntityQueries $entityQueries,
+        protected TrashCan $trashCan,
+    ) {

     }
 
     /**
     }
 
     /**


@@ -44,12 +28,18 @@ class ChapterRepo
      */
     public function create(array $input, Book $parentBook): Chapter
     {
      */
     public function create(array $input, Book $parentBook): Chapter
     {

-        $chapter = new Chapter();
-        $chapter->book_id = $parentBook->id;
-        $chapter->priority = (new BookContents($parentBook))->getLastPriority() + 1;
-        $this->baseRepo->create($chapter, $input);
-        Activity::addForEntity($chapter, ActivityType::CHAPTER_CREATE);
-        return $chapter;
+        return (new DatabaseTransaction(function () use ($input, $parentBook) {
+            $chapter = new Chapter();
+            $chapter->book_id = $parentBook->id;
+            $chapter->priority = (new BookContents($parentBook))->getLastPriority() + 1;
+            $this->baseRepo->create($chapter, $input);
+            $this->baseRepo->updateDefaultTemplate($chapter, intval($input['default_template_id'] ?? null));
+            Activity::add(ActivityType::CHAPTER_CREATE, $chapter);
+
+            $this->baseRepo->sortParent($chapter);
+
+            return $chapter;
+        }))->run();

     }
 
     /**
     }
 
     /**


@@ -58,48 +48,57 @@ class ChapterRepo
     public function update(Chapter $chapter, array $input): Chapter
     {
         $this->baseRepo->update($chapter, $input);
     public function update(Chapter $chapter, array $input): Chapter
     {
         $this->baseRepo->update($chapter, $input);

-        Activity::addForEntity($chapter, ActivityType::CHAPTER_UPDATE);
+
+        if (array_key_exists('default_template_id', $input)) {
+            $this->baseRepo->updateDefaultTemplate($chapter, intval($input['default_template_id']));
+        }
+
+        Activity::add(ActivityType::CHAPTER_UPDATE, $chapter);
+
+        $this->baseRepo->sortParent($chapter);
+

         return $chapter;
     }
 
     /**
      * Remove a chapter from the system.
         return $chapter;
     }
 
     /**
      * Remove a chapter from the system.

+     *

      * @throws Exception
      */
     public function destroy(Chapter $chapter)
     {
      * @throws Exception
      */
     public function destroy(Chapter $chapter)
     {

-        $trashCan = new TrashCan();
-        $trashCan->softDestroyChapter($chapter);
-        Activity::addForEntity($chapter, ActivityType::CHAPTER_DELETE);
-        $trashCan->autoClearOld();
+        $this->trashCan->softDestroyChapter($chapter);
+        Activity::add(ActivityType::CHAPTER_DELETE, $chapter);
+        $this->trashCan->autoClearOld();

     }
 
     /**
      * Move the given chapter into a new parent book.
      * The $parentIdentifier must be a string of the following format:
     }
 
     /**
      * Move the given chapter into a new parent book.
      * The $parentIdentifier must be a string of the following format:

-     * 'book:<id>' (book:5)
+     * 'book:<id>' (book:5).
+     *

      * @throws MoveOperationException
      * @throws MoveOperationException

+     * @throws PermissionsException

      */
     public function move(Chapter $chapter, string $parentIdentifier): Book
     {
      */
     public function move(Chapter $chapter, string $parentIdentifier): Book
     {

-        $stringExploded = explode(':', $parentIdentifier);
-        $entityType = $stringExploded[0];
-        $entityId = intval($stringExploded[1]);
-
-        if ($entityType !== 'book') {
-            throw new MoveOperationException('Chapters can only be moved into books');
+        $parent = $this->entityQueries->findVisibleByStringIdentifier($parentIdentifier);
+        if (!$parent instanceof Book) {
+            throw new MoveOperationException('Book to move chapter into not found');

         }
 
         }
 

-        /** @var Book $parent */
-        $parent = Book::visible()->where('id', '=', $entityId)->first();
-        if ($parent === null) {
-            throw new MoveOperationException('Book to move chapter into not found');
+        if (!userCan('chapter-create', $parent)) {
+            throw new PermissionsException('User does not have permission to create a chapter within the chosen book');

         }
 
         }
 

-        $chapter->changeBook($parent->id);
-        $chapter->rebuildPermissions();
-        Activity::addForEntity($chapter, ActivityType::CHAPTER_MOVE);
+        return (new DatabaseTransaction(function () use ($chapter, $parent) {
+            $chapter->changeBook($parent->id);
+            $chapter->rebuildPermissions();
+            Activity::add(ActivityType::CHAPTER_MOVE, $chapter);
+
+            $this->baseRepo->sortParent($chapter);

 
 

-        return $parent;
+            return $parent;
+        }))->run();

     }
 }
     }
 }