BookStack/app/Http/Controllers/Api/BookApiController.php

101 lines
2.5 KiB
PHP
Raw Normal View History

2021-06-26 11:23:15 -04:00
<?php
namespace BookStack\Http\Controllers\Api;
2019-12-28 09:58:07 -05:00
use BookStack\Entities\Models\Book;
use BookStack\Entities\Repos\BookRepo;
use Illuminate\Http\Request;
2020-01-15 15:18:02 -05:00
use Illuminate\Validation\ValidationException;
2019-12-28 09:58:07 -05:00
2020-05-22 19:28:41 -04:00
class BookApiController extends ApiController
2019-12-28 09:58:07 -05:00
{
protected $bookRepo;
protected $rules = [
'create' => [
'name' => ['required', 'string', 'max:255'],
'description' => ['string', 'max:1000'],
'tags' => ['array'],
],
'update' => [
'name' => ['string', 'min:1', 'max:255'],
'description' => ['string', 'max:1000'],
'tags' => ['array'],
],
];
public function __construct(BookRepo $bookRepo)
{
$this->bookRepo = $bookRepo;
}
2019-12-28 09:58:07 -05:00
/**
* Get a listing of books visible to the user.
*/
2020-01-18 09:03:11 -05:00
public function list()
2019-12-28 09:58:07 -05:00
{
$books = Book::visible();
2021-06-26 11:23:15 -04:00
2019-12-28 09:58:07 -05:00
return $this->apiListingResponse($books, [
'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by',
2019-12-28 09:58:07 -05:00
]);
}
/**
2020-01-15 15:18:02 -05:00
* Create a new book in the system.
2021-06-26 11:23:15 -04:00
*
2020-01-15 15:18:02 -05:00
* @throws ValidationException
*/
public function create(Request $request)
{
$this->checkPermission('book-create-all');
$requestData = $this->validate($request, $this->rules['create']);
$book = $this->bookRepo->create($requestData);
2021-06-26 11:23:15 -04:00
return response()->json($book);
}
/**
* View the details of a single book.
*/
public function read(string $id)
{
$book = Book::visible()->with(['tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy'])->findOrFail($id);
2021-06-26 11:23:15 -04:00
return response()->json($book);
}
/**
* Update the details of a single book.
2021-06-26 11:23:15 -04:00
*
2020-01-15 15:18:02 -05:00
* @throws ValidationException
*/
public function update(Request $request, string $id)
{
$book = Book::visible()->findOrFail($id);
$this->checkOwnablePermission('book-update', $book);
$requestData = $this->validate($request, $this->rules['update']);
$book = $this->bookRepo->update($book, $requestData);
return response()->json($book);
}
/**
* Delete a single book.
* This will typically send the book to the recycle bin.
2021-06-26 11:23:15 -04:00
*
* @throws \Exception
*/
public function delete(string $id)
{
$book = Book::visible()->findOrFail($id);
$this->checkOwnablePermission('book-delete', $book);
$this->bookRepo->destroy($book);
2021-06-26 11:23:15 -04:00
return response('', 204);
}
2021-03-07 17:24:05 -05:00
}