Add default_template as Book setting

[bookstack] / app / Http / Controllers / Api / BookApiController.php

diff --git a/app/Http/Controllers/Api/BookApiController.php b/app/Http/Controllers/Api/BookApiController.php
index 73cac6318a994f65121278d73d8ba319bfd72f14..d57b48a43fcdbeeccfa7a9b58f5e8bfde9dc9cea 100644 (file)
--- a/app/Http/Controllers/Api/BookApiController.php
+++ b/app/Http/Controllers/Api/BookApiController.php
@@ -2,14 +2,18 @@
 
 namespace BookStack\Http\Controllers\Api;
 
 
 namespace BookStack\Http\Controllers\Api;
 

+use BookStack\Api\ApiEntityListFormatter;

 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Book;

+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Entity;

 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Repos\BookRepo;

+use BookStack\Entities\Tools\BookContents;

 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 
 class BookApiController extends ApiController
 {
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 
 class BookApiController extends ApiController
 {

-    protected $bookRepo;
+    protected BookRepo $bookRepo;

 
     public function __construct(BookRepo $bookRepo)
     {
 
     public function __construct(BookRepo $bookRepo)
     {


@@ -30,13 +34,15 @@ class BookApiController extends ApiController
 
     /**
      * Create a new book in the system.
 
     /**
      * Create a new book in the system.

+     * The cover image of a book can be set by sending a file via an 'image' property within a 'multipart/form-data' request.
+     * If the 'image' property is null then the book cover image will be removed.

      *
      * @throws ValidationException
      */
     public function create(Request $request)
     {
         $this->checkPermission('book-create-all');
      *
      * @throws ValidationException
      */
     public function create(Request $request)
     {
         $this->checkPermission('book-create-all');

-        $requestData = $this->validate($request, $this->rules['create']);
+        $requestData = $this->validate($request, $this->rules()['create']);

 
         $book = $this->bookRepo->create($requestData);
 
 
         $book = $this->bookRepo->create($requestData);
 


@@ -45,16 +51,32 @@ class BookApiController extends ApiController
 
     /**
      * View the details of a single book.
 
     /**
      * View the details of a single book.

+     * The response data will contain 'content' property listing the chapter and pages directly within, in
+     * the same structure as you'd see within the BookStack interface when viewing a book. Top-level
+     * contents will have a 'type' property to distinguish between pages & chapters.

      */
     public function read(string $id)
     {
         $book = Book::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy'])->findOrFail($id);
 
      */
     public function read(string $id)
     {
         $book = Book::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy'])->findOrFail($id);
 

+        $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();
+                }
+                return null;
+            })->format();
+        $book->setAttribute('contents', $contentsApiData);
+

         return response()->json($book);
     }
 
     /**
      * Update the details of a single book.
         return response()->json($book);
     }
 
     /**
      * Update the details of a single book.

+     * The cover image of a book can be set by sending a file via an 'image' property within a 'multipart/form-data' request.
+     * If the 'image' property is null then the book cover image will be removed.

      *
      * @throws ValidationException
      */
      *
      * @throws ValidationException
      */


@@ -63,7 +85,7 @@ class BookApiController extends ApiController
         $book = Book::visible()->findOrFail($id);
         $this->checkOwnablePermission('book-update', $book);
 
         $book = Book::visible()->findOrFail($id);
         $this->checkOwnablePermission('book-update', $book);
 

-        $requestData = $this->validate($request, $this->rules['update']);
+        $requestData = $this->validate($request, $this->rules()['update']);

         $book = $this->bookRepo->update($book, $requestData);
 
         return response()->json($book);
         $book = $this->bookRepo->update($book, $requestData);
 
         return response()->json($book);


@@ -85,7 +107,8 @@ class BookApiController extends ApiController
         return response('', 204);
     }
 
         return response('', 204);
     }
 

-    protected function rules(): array {
+    protected function rules(): array
+    {

         return [
             'create' => [
                 'name'        => ['required', 'string', 'max:255'],
         return [
             'create' => [
                 'name'        => ['required', 'string', 'max:255'],