X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/da1cea06ca5db56a9635bf8bb01da2516d601620..refs/pull/2730/head:/app/Http/Controllers/Api/BookshelfApiController.php diff --git a/app/Http/Controllers/Api/BookshelfApiController.php b/app/Http/Controllers/Api/BookshelfApiController.php index e6379fdec..4ce93defa 100644 --- a/app/Http/Controllers/Api/BookshelfApiController.php +++ b/app/Http/Controllers/Api/BookshelfApiController.php @@ -1,13 +1,12 @@ [ 'name' => 'required|string|max:255', 'description' => 'string|max:1000', + 'books' => 'array', ], 'update' => [ 'name' => 'string|min:1|max:255', 'description' => 'string|max:1000', + 'books' => 'array', ], ]; /** * BookshelfApiController constructor. - * @param BookshelfRepo $bookshelfRepo */ public function __construct(BookshelfRepo $bookshelfRepo) { @@ -43,12 +43,14 @@ class BookshelfApiController extends ApiController { $shelves = Bookshelf::visible(); return $this->apiListingResponse($shelves, [ - 'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'image_id', + 'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by', 'image_id', ]); } /** * Create a new shelf in the system. + * An array of books IDs can be provided in the request. These + * will be added to the shelf in the same order as provided. * @throws ValidationException */ public function create(Request $request) @@ -57,9 +59,7 @@ class BookshelfApiController extends ApiController $requestData = $this->validate($request, $this->rules['create']); $bookIds = $request->get('books', []); - - $shelf = $this->bookshelfRepo->create($requestData,$bookIds); - Activity::add($shelf, 'bookshelf_create', $shelf->id); + $shelf = $this->bookshelfRepo->create($requestData, $bookIds); return response()->json($shelf); } @@ -69,12 +69,20 @@ class BookshelfApiController extends ApiController */ public function read(string $id) { - $shelf = Bookshelf::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy'])->findOrFail($id); + $shelf = Bookshelf::visible()->with([ + 'tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy', + 'books' => function (BelongsToMany $query) { + $query->visible()->get(['id', 'name', 'slug']); + } + ])->findOrFail($id); return response()->json($shelf); } /** * Update the details of a single shelf. + * An array of books IDs can be provided in the request. These + * will be added to the shelf in the same order as provided and overwrite + * any existing book assignments. * @throws ValidationException */ public function update(Request $request, string $id) @@ -83,21 +91,17 @@ class BookshelfApiController extends ApiController $this->checkOwnablePermission('bookshelf-update', $shelf); $requestData = $this->validate($request, $this->rules['update']); + $bookIds = $request->get('books', null); - $bookIds = $request->get('books', []); - - $shelf = $this->bookshelfRepo->update($shelf, $requestData,$bookIds); - Activity::add($shelf, 'bookshelf_update', $shelf->id); - + $shelf = $this->bookshelfRepo->update($shelf, $requestData, $bookIds); return response()->json($shelf); } /** - * Delete a single shelf from the system. - * @param string $id - * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\Response + * Delete a single shelf. + * This will typically send the shelf to the recycle bin. * @throws Exception */ public function delete(string $id) @@ -106,8 +110,6 @@ class BookshelfApiController extends ApiController $this->checkOwnablePermission('bookshelf-delete', $shelf); $this->bookshelfRepo->destroy($shelf); - Activity::addMessage('bookshelf-delete', $shelf->name); - return response('', 204); } -} \ No newline at end of file +}