Quick run through of applying new test entity helper class

[bookstack] / app / Http / Controllers / BookshelfController.php

diff --git a/app/Http/Controllers/BookshelfController.php b/app/Http/Controllers/BookshelfController.php
index 2f966beed11cee6332549ae66b1f2f61e7ce1c24..2143b876a517dc10dd8df31f09101af8ef97e90e 100644 (file)
--- a/app/Http/Controllers/BookshelfController.php
+++ b/app/Http/Controllers/BookshelfController.php
@@ -10,22 +10,22 @@ use BookStack\Entities\Tools\PermissionsUpdater;
 use BookStack\Entities\Tools\ShelfContext;
 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Exceptions\NotFoundException;
 use BookStack\Entities\Tools\ShelfContext;
 use BookStack\Exceptions\ImageUploadException;
 use BookStack\Exceptions\NotFoundException;

-use BookStack\Uploads\ImageRepo;
+use BookStack\References\ReferenceFetcher;

 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 
 class BookshelfController extends Controller
 {
 use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 
 class BookshelfController extends Controller
 {

-    protected $bookshelfRepo;
-    protected $entityContextManager;
-    protected $imageRepo;
+    protected BookshelfRepo $shelfRepo;
+    protected ShelfContext $shelfContext;
+    protected ReferenceFetcher $referenceFetcher;

 
 

-    public function __construct(BookshelfRepo $bookshelfRepo, ShelfContext $entityContextManager, ImageRepo $imageRepo)
+    public function __construct(BookshelfRepo $shelfRepo, ShelfContext $shelfContext, ReferenceFetcher $referenceFetcher)

     {
     {

-        $this->bookshelfRepo = $bookshelfRepo;
-        $this->entityContextManager = $entityContextManager;
-        $this->imageRepo = $imageRepo;
+        $this->shelfRepo = $shelfRepo;
+        $this->shelfContext = $shelfContext;
+        $this->referenceFetcher = $referenceFetcher;

     }
 
     /**
     }
 
     /**


@@ -42,12 +42,12 @@ class BookshelfController extends Controller
             'updated_at' => trans('common.sort_updated_at'),
         ];
 
             'updated_at' => trans('common.sort_updated_at'),
         ];
 

-        $shelves = $this->bookshelfRepo->getAllPaginated(18, $sort, $order);
-        $recents = $this->isSignedIn() ? $this->bookshelfRepo->getRecentlyViewed(4) : false;
-        $popular = $this->bookshelfRepo->getPopular(4);
-        $new = $this->bookshelfRepo->getRecentlyCreated(4);
+        $shelves = $this->shelfRepo->getAllPaginated(18, $sort, $order);
+        $recents = $this->isSignedIn() ? $this->shelfRepo->getRecentlyViewed(4) : false;
+        $popular = $this->shelfRepo->getPopular(4);
+        $new = $this->shelfRepo->getRecentlyCreated(4);

 
 

-        $this->entityContextManager->clearShelfContext();
+        $this->shelfContext->clearShelfContext();

         $this->setPageTitle(trans('entities.shelves'));
 
         return view('shelves.index', [
         $this->setPageTitle(trans('entities.shelves'));
 
         return view('shelves.index', [


@@ -68,7 +68,7 @@ class BookshelfController extends Controller
     public function create()
     {
         $this->checkPermission('bookshelf-create-all');
     public function create()
     {
         $this->checkPermission('bookshelf-create-all');

-        $books = Book::hasPermission('update')->get();
+        $books = Book::visible()->orderBy('name')->get(['name', 'id', 'slug']);

         $this->setPageTitle(trans('entities.shelves_create'));
 
         return view('shelves.create', ['books' => $books]);
         $this->setPageTitle(trans('entities.shelves_create'));
 
         return view('shelves.create', ['books' => $books]);


@@ -87,10 +87,11 @@ class BookshelfController extends Controller
             'name'        => ['required', 'string', 'max:255'],
             'description' => ['string', 'max:1000'],
             'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
             'name'        => ['required', 'string', 'max:255'],
             'description' => ['string', 'max:1000'],
             'image'       => array_merge(['nullable'], $this->getImageValidationRules()),

+            'tags'        => ['array'],

         ]);
 
         $bookIds = explode(',', $request->get('books', ''));
         ]);
 
         $bookIds = explode(',', $request->get('books', ''));

-        $shelf = $this->bookshelfRepo->create($validated, $bookIds);
+        $shelf = $this->shelfRepo->create($validated, $bookIds);

 
         return redirect($shelf->getUrl());
     }
 
         return redirect($shelf->getUrl());
     }


@@ -102,8 +103,8 @@ class BookshelfController extends Controller
      */
     public function show(ActivityQueries $activities, string $slug)
     {
      */
     public function show(ActivityQueries $activities, string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
-        $this->checkOwnablePermission('book-view', $shelf);
+        $shelf = $this->shelfRepo->getBySlug($slug);
+        $this->checkOwnablePermission('bookshelf-view', $shelf);

 
         $sort = setting()->getForCurrentUser('shelf_books_sort', 'default');
         $order = setting()->getForCurrentUser('shelf_books_sort_order', 'asc');
 
         $sort = setting()->getForCurrentUser('shelf_books_sort', 'default');
         $order = setting()->getForCurrentUser('shelf_books_sort_order', 'asc');


@@ -114,7 +115,7 @@ class BookshelfController extends Controller
             ->all();
 
         View::incrementFor($shelf);
             ->all();
 
         View::incrementFor($shelf);

-        $this->entityContextManager->setShelfContext($shelf->id);
+        $this->shelfContext->setShelfContext($shelf->id);

         $view = setting()->getForCurrentUser('bookshelf_view_type');
 
         $this->setPageTitle($shelf->getShortName());
         $view = setting()->getForCurrentUser('bookshelf_view_type');
 
         $this->setPageTitle($shelf->getShortName());


@@ -126,6 +127,7 @@ class BookshelfController extends Controller
             'activity'                => $activities->entityActivity($shelf, 20, 1),
             'order'                   => $order,
             'sort'                    => $sort,
             'activity'                => $activities->entityActivity($shelf, 20, 1),
             'order'                   => $order,
             'sort'                    => $sort,

+            'referenceCount'          => $this->referenceFetcher->getPageReferenceCountToEntity($shelf),

         ]);
     }
 
         ]);
     }
 


@@ -134,11 +136,11 @@ class BookshelfController extends Controller
      */
     public function edit(string $slug)
     {
      */
     public function edit(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-update', $shelf);
 
         $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');
         $this->checkOwnablePermission('bookshelf-update', $shelf);
 
         $shelfBookIds = $shelf->books()->get(['id'])->pluck('id');

-        $books = Book::hasPermission('update')->whereNotIn('id', $shelfBookIds)->get();
+        $books = Book::visible()->whereNotIn('id', $shelfBookIds)->orderBy('name')->get(['name', 'id', 'slug']);

 
         $this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));
 
 
         $this->setPageTitle(trans('entities.shelves_edit_named', ['name' => $shelf->getShortName()]));
 


@@ -157,22 +159,23 @@ class BookshelfController extends Controller
      */
     public function update(Request $request, string $slug)
     {
      */
     public function update(Request $request, string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-update', $shelf);
         $validated = $this->validate($request, [
             'name'        => ['required', 'string', 'max:255'],
             'description' => ['string', 'max:1000'],
             'image'       => array_merge(['nullable'], $this->getImageValidationRules()),
         $this->checkOwnablePermission('bookshelf-update', $shelf);
         $validated = $this->validate($request, [
             'name'        => ['required', 'string', 'max:255'],
             'description' => ['string', 'max:1000'],
             'image'       => array_merge(['nullable'], $this->getImageValidationRules()),

+            'tags'        => ['array'],

         ]);
 
         if ($request->has('image_reset')) {
             $validated['image'] = null;
         ]);
 
         if ($request->has('image_reset')) {
             $validated['image'] = null;

-        } else if (array_key_exists('image', $validated) && is_null($validated['image'])) {
+        } elseif (array_key_exists('image', $validated) && is_null($validated['image'])) {

             unset($validated['image']);
         }
 
         $bookIds = explode(',', $request->get('books', ''));
             unset($validated['image']);
         }
 
         $bookIds = explode(',', $request->get('books', ''));

-        $shelf = $this->bookshelfRepo->update($shelf, $validated, $bookIds);
+        $shelf = $this->shelfRepo->update($shelf, $validated, $bookIds);

 
         return redirect($shelf->getUrl());
     }
 
         return redirect($shelf->getUrl());
     }


@@ -182,7 +185,7 @@ class BookshelfController extends Controller
      */
     public function showDelete(string $slug)
     {
      */
     public function showDelete(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 
         $this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));
         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 
         $this->setPageTitle(trans('entities.shelves_delete_named', ['name' => $shelf->getShortName()]));


@@ -197,10 +200,10 @@ class BookshelfController extends Controller
      */
     public function destroy(string $slug)
     {
      */
     public function destroy(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 
         $this->checkOwnablePermission('bookshelf-delete', $shelf);
 

-        $this->bookshelfRepo->destroy($shelf);
+        $this->shelfRepo->destroy($shelf);

 
         return redirect('/shelves');
     }
 
         return redirect('/shelves');
     }


@@ -210,7 +213,7 @@ class BookshelfController extends Controller
      */
     public function showPermissions(string $slug)
     {
      */
     public function showPermissions(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         return view('shelves.permissions', [
         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         return view('shelves.permissions', [


@@ -223,7 +226,7 @@ class BookshelfController extends Controller
      */
     public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)
     {
      */
     public function permissions(Request $request, PermissionsUpdater $permissionsUpdater, string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         $permissionsUpdater->updateFromPermissionsForm($shelf, $request);
         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         $permissionsUpdater->updateFromPermissionsForm($shelf, $request);


@@ -238,10 +241,10 @@ class BookshelfController extends Controller
      */
     public function copyPermissions(string $slug)
     {
      */
     public function copyPermissions(string $slug)
     {

-        $shelf = $this->bookshelfRepo->getBySlug($slug);
+        $shelf = $this->shelfRepo->getBySlug($slug);

         $this->checkOwnablePermission('restrictions-manage', $shelf);
 
         $this->checkOwnablePermission('restrictions-manage', $shelf);
 

-        $updateCount = $this->bookshelfRepo->copyDownPermissions($shelf);
+        $updateCount = $this->shelfRepo->copyDownPermissions($shelf);

         $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
 
         return redirect($shelf->getUrl());
         $this->showSuccessNotification(trans('entities.shelves_copy_permission_success', ['count' => $updateCount]));
 
         return redirect($shelf->getUrl());