use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Queries\BookQueries;
+use BookStack\Entities\Queries\PageQueries;
use BookStack\Entities\Repos\BookRepo;
use BookStack\Entities\Tools\BookContents;
use BookStack\Http\ApiController;
class BookApiController extends ApiController
{
- protected BookRepo $bookRepo;
-
- public function __construct(BookRepo $bookRepo)
- {
- $this->bookRepo = $bookRepo;
+ public function __construct(
+ protected BookRepo $bookRepo,
+ protected BookQueries $queries,
+ protected PageQueries $pageQueries,
+ ) {
}
/**
*/
public function list()
{
- $books = Book::visible();
+ $books = $this->queries
+ ->visibleForList()
+ ->with(['cover:id,name,url'])
+ ->addSelect(['created_by', 'updated_by']);
return $this->apiListingResponse($books, [
'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by',
$book = $this->bookRepo->create($requestData);
- return response()->json($book);
+ return response()->json($this->forJsonDisplay($book));
}
/**
*/
public function read(string $id)
{
- $book = Book::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy'])->findOrFail($id);
+ $book = $this->queries->findVisibleByIdOrFail(intval($id));
+ $book = $this->forJsonDisplay($book);
+ $book->load(['createdBy', 'updatedBy', 'ownedBy']);
$contents = (new BookContents($book))->getTree(true, false)->all();
$contentsApiData = (new ApiEntityListFormatter($contents))
->withType()
->withField('pages', function (Entity $entity) {
if ($entity instanceof Chapter) {
- return (new ApiEntityListFormatter($entity->pages->all()))->format();
+ $pages = $this->pageQueries->visibleForChapterList($entity->id)->get()->all();
+ return (new ApiEntityListFormatter($pages))->format();
}
return null;
})->format();
*/
public function update(Request $request, string $id)
{
- $book = Book::visible()->findOrFail($id);
+ $book = $this->queries->findVisibleByIdOrFail(intval($id));
$this->checkOwnablePermission('book-update', $book);
$requestData = $this->validate($request, $this->rules()['update']);
$book = $this->bookRepo->update($book, $requestData);
- return response()->json($book);
+ return response()->json($this->forJsonDisplay($book));
}
/**
*/
public function delete(string $id)
{
- $book = Book::visible()->findOrFail($id);
+ $book = $this->queries->findVisibleByIdOrFail(intval($id));
$this->checkOwnablePermission('book-delete', $book);
$this->bookRepo->destroy($book);
return response('', 204);
}
+ protected function forJsonDisplay(Book $book): Book
+ {
+ $book = clone $book;
+ $book->unsetRelations()->refresh();
+
+ $book->load(['tags', 'cover']);
+ $book->makeVisible('description_html')
+ ->setAttribute('description_html', $book->descriptionHtml());
+
+ return $book;
+ }
+
protected function rules(): array
{
return [
'create' => [
- 'name' => ['required', 'string', 'max:255'],
- 'description' => ['string', 'max:1000'],
- 'tags' => ['array'],
- 'image' => array_merge(['nullable'], $this->getImageValidationRules()),
+ 'name' => ['required', 'string', 'max:255'],
+ 'description' => ['string', 'max:1900'],
+ 'description_html' => ['string', 'max:2000'],
+ 'tags' => ['array'],
+ 'image' => array_merge(['nullable'], $this->getImageValidationRules()),
+ 'default_template_id' => ['nullable', 'integer'],
],
'update' => [
- 'name' => ['string', 'min:1', 'max:255'],
- 'description' => ['string', 'max:1000'],
- 'tags' => ['array'],
- 'image' => array_merge(['nullable'], $this->getImageValidationRules()),
+ 'name' => ['string', 'min:1', 'max:255'],
+ 'description' => ['string', 'max:1900'],
+ 'description_html' => ['string', 'max:2000'],
+ 'tags' => ['array'],
+ 'image' => array_merge(['nullable'], $this->getImageValidationRules()),
+ 'default_template_id' => ['nullable', 'integer'],
],
];
}