Entity Repo & Controller Refactor (#1690)

* Started mass-refactoring of the current entity repos * Rewrote book tree logic - Now does two simple queries instead of one really complex one. - Extracted logic into its own class. - Remove model-level akward union field listing. - Logic now more readable than being large separate query and compilation functions. * Extracted and split book sort logic * Finished up Book controller/repo organisation * Refactored bookshelves controllers and repo parts * Fixed issues found via phpunit * Refactored Chapter controller * Updated Chapter export controller * Started Page controller/repo refactor * Refactored another chunk of PageController * Completed initial pagecontroller refactor pass * Fixed tests and continued reduction of old repos * Removed old page remove and further reduced entity repo * Removed old entity repo, split out page controller * Ran phpcbf and split out some page content methods * Tidied up some EntityProvider elements * Fixed issued caused by viewservice change
2025-06-18 10:22:28 +08:00 · 2019-10-05 12:55:01 +01:00
parent 7cd956b24b
commit 31f5786e01
72 changed files with 2705 additions and 2751 deletions
--- a/app/Http/Controllers/BookSortController.php
+++ b/app/Http/Controllers/BookSortController.php
@ -0,0 +1,82 @@
+<?php
+
+namespace BookStack\Http\Controllers;
+
+use BookStack\Entities\Book;
+use BookStack\Entities\Managers\BookContents;
+use BookStack\Entities\Repos\BookRepo;
+use BookStack\Exceptions\SortOperationException;
+use BookStack\Facades\Activity;
+use Illuminate\Http\Request;
+
+class BookSortController extends Controller
+{
+
+    protected $bookRepo;
+
+    /**
+     * BookSortController constructor.
+     * @param $bookRepo
+     */
+    public function __construct(BookRepo $bookRepo)
+    {
+        $this->bookRepo = $bookRepo;
+        parent::__construct();
+    }
+
+    /**
+     * Shows the view which allows pages to be re-ordered and sorted.
+     */
+    public function show(string $bookSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $this->checkOwnablePermission('book-update', $book);
+
+        $bookChildren = (new BookContents($book))->getTree(false);
+
+        $this->setPageTitle(trans('entities.books_sort_named', ['bookName'=>$book->getShortName()]));
+        return view('books.sort', ['book' => $book, 'current' => $book, 'bookChildren' => $bookChildren]);
+    }
+
+    /**
+     * Shows the sort box for a single book.
+     * Used via AJAX when loading in extra books to a sort.
+     */
+    public function showItem(string $bookSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $bookChildren = (new BookContents($book))->getTree();
+        return view('books.sort-box', ['book' => $book, 'bookChildren' => $bookChildren]);
+    }
+
+    /**
+     * Sorts a book using a given mapping array.
+     */
+    public function update(Request $request, string $bookSlug)
+    {
+        $book = $this->bookRepo->getBySlug($bookSlug);
+        $this->checkOwnablePermission('book-update', $book);
+
+        // Return if no map sent
+        if (!$request->filled('sort-tree')) {
+            return redirect($book->getUrl());
+        }
+
+        $sortMap = collect(json_decode($request->get('sort-tree')));
+        $bookContents = new BookContents($book);
+        $booksInvolved = collect();
+
+        try {
+            $booksInvolved = $bookContents->sortUsingMap($sortMap);
+        } catch (SortOperationException $exception) {
+            $this->showPermissionError();
+        }
+
+        // Rebuild permissions and add activity for involved books.
+        $booksInvolved->each(function (Book $book) {
+            Activity::add($book, 'book_sort', $book->id);
+        });
+
+        return redirect($book->getUrl());
+    }
+}