use BookStack\Entities\Repos\BookshelfRepo;
use BookStack\Entities\Bookshelf;
use Exception;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
-
class BookshelfApiController extends ApiController
{
'create' => [
'name' => 'required|string|max:255',
'description' => 'string|max:1000',
+ 'books' => 'array',
],
'update' => [
'name' => 'string|min:1|max:255',
'description' => 'string|max:1000',
+ 'books' => 'array',
],
];
/**
* 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)
$requestData = $this->validate($request, $this->rules['create']);
$bookIds = $request->get('books', []);
+ $shelf = $this->bookshelfRepo->create($requestData, $bookIds);
- $shelf = $this->bookshelfRepo->create($requestData,$bookIds);
Activity::add($shelf, 'bookshelf_create', $shelf->id);
-
return response()->json($shelf);
}
*/
public function read(string $id)
{
- $shelf = Bookshelf::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy'])->findOrFail($id);
+ $shelf = Bookshelf::visible()->with([
+ 'tags', 'cover', 'createdBy', 'updatedBy',
+ '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)
$requestData = $this->validate($request, $this->rules['update']);
- $bookIds = $request->get('books', []);
+ $bookIds = $request->get('books', null);
- $shelf = $this->bookshelfRepo->update($shelf, $requestData,$bookIds);
+ $shelf = $this->bookshelfRepo->update($shelf, $requestData, $bookIds);
Activity::add($shelf, 'bookshelf_update', $shelf->id);
return response()->json($shelf);
/**
* Delete a single shelf from the system.
- * @param string $id
- * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\Response
* @throws Exception
*/
public function delete(string $id)
$this->checkOwnablePermission('bookshelf-delete', $shelf);
$this->bookshelfRepo->destroy($shelf);
- Activity::addMessage('bookshelf-delete', $shelf->name);
+ Activity::addMessage('bookshelf_delete', $shelf->name);
return response('', 204);
}