]> BookStack Code Mirror - bookstack/blob - app/Entities/Repos/ChapterRepo.php
Add LDAP_TLS_CACERTFILE to example env file
[bookstack] / app / Entities / Repos / ChapterRepo.php
1 <?php
2
3 namespace BookStack\Entities\Repos;
4
5 use BookStack\Activity\ActivityType;
6 use BookStack\Entities\Models\Book;
7 use BookStack\Entities\Models\Chapter;
8 use BookStack\Entities\Queries\EntityQueries;
9 use BookStack\Entities\Tools\BookContents;
10 use BookStack\Entities\Tools\TrashCan;
11 use BookStack\Exceptions\MoveOperationException;
12 use BookStack\Exceptions\PermissionsException;
13 use BookStack\Facades\Activity;
14 use Exception;
15
16 class ChapterRepo
17 {
18     public function __construct(
19         protected BaseRepo $baseRepo,
20         protected EntityQueries $entityQueries,
21         protected TrashCan $trashCan,
22     ) {
23     }
24
25     /**
26      * Create a new chapter in the system.
27      */
28     public function create(array $input, Book $parentBook): Chapter
29     {
30         $chapter = new Chapter();
31         $chapter->book_id = $parentBook->id;
32         $chapter->priority = (new BookContents($parentBook))->getLastPriority() + 1;
33         $this->baseRepo->create($chapter, $input);
34         $this->baseRepo->updateDefaultTemplate($chapter, intval($input['default_template_id'] ?? null));
35         Activity::add(ActivityType::CHAPTER_CREATE, $chapter);
36
37         return $chapter;
38     }
39
40     /**
41      * Update the given chapter.
42      */
43     public function update(Chapter $chapter, array $input): Chapter
44     {
45         $this->baseRepo->update($chapter, $input);
46
47         if (array_key_exists('default_template_id', $input)) {
48             $this->baseRepo->updateDefaultTemplate($chapter, intval($input['default_template_id']));
49         }
50
51         Activity::add(ActivityType::CHAPTER_UPDATE, $chapter);
52
53         return $chapter;
54     }
55
56     /**
57      * Remove a chapter from the system.
58      *
59      * @throws Exception
60      */
61     public function destroy(Chapter $chapter)
62     {
63         $this->trashCan->softDestroyChapter($chapter);
64         Activity::add(ActivityType::CHAPTER_DELETE, $chapter);
65         $this->trashCan->autoClearOld();
66     }
67
68     /**
69      * Move the given chapter into a new parent book.
70      * The $parentIdentifier must be a string of the following format:
71      * 'book:<id>' (book:5).
72      *
73      * @throws MoveOperationException
74      * @throws PermissionsException
75      */
76     public function move(Chapter $chapter, string $parentIdentifier): Book
77     {
78         $parent = $this->entityQueries->findVisibleByStringIdentifier($parentIdentifier);
79         if (!$parent instanceof Book) {
80             throw new MoveOperationException('Book to move chapter into not found');
81         }
82
83         if (!userCan('chapter-create', $parent)) {
84             throw new PermissionsException('User does not have permission to create a chapter within the chosen book');
85         }
86
87         $chapter->changeBook($parent->id);
88         $chapter->rebuildPermissions();
89         Activity::add(ActivityType::CHAPTER_MOVE, $chapter);
90
91         return $parent;
92     }
93 }