Add default_template as Book setting

This commit is contained in:
Lennert Daniels 2022-12-02 18:41:59 +01:00
parent 3599a962a3
commit 1dbc3588cf
8 changed files with 86 additions and 4 deletions

View file

@ -27,7 +27,7 @@ class Book extends Entity implements HasCoverImage
public $searchFactor = 1.2;
protected $fillable = ['name', 'description'];
protected $fillable = ['name', 'description', 'default_template'];
protected $hidden = ['pivot', 'image_id', 'deleted_at'];
/**
@ -78,6 +78,14 @@ class Book extends Entity implements HasCoverImage
return 'cover_book';
}
/**
* Get the Page that is used as default template for newly created pages within this Book.
*/
public function defaultTemplate(): BelongsTo
{
return $this->belongsTo(Page::class, 'default_template');
}
/**
* Get all pages within this book.
*/

View file

@ -6,6 +6,7 @@ use BookStack\Actions\ActivityQueries;
use BookStack\Actions\ActivityType;
use BookStack\Actions\View;
use BookStack\Entities\Models\Bookshelf;
use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\BookRepo;
use BookStack\Entities\Tools\BookContents;
use BookStack\Entities\Tools\Cloner;
@ -79,8 +80,14 @@ class BookController extends Controller
$this->setPageTitle(trans('entities.books_create'));
$templates = Page::visible()
->where('template', '=', true)
->orderBy('name', 'asc')
->get();
return view('books.create', [
'bookshelf' => $bookshelf,
'templates' => $templates,
]);
}
@ -98,6 +105,7 @@ class BookController extends Controller
'description' => ['string', 'max:1000'],
'image' => array_merge(['nullable'], $this->getImageValidationRules()),
'tags' => ['array'],
'default_template' => ['nullable', 'exists:pages,id'],
]);
$bookshelf = null;
@ -151,7 +159,12 @@ class BookController extends Controller
$this->checkOwnablePermission('book-update', $book);
$this->setPageTitle(trans('entities.books_edit_named', ['bookName' => $book->getShortName()]));
return view('books.edit', ['book' => $book, 'current' => $book]);
$templates = Page::visible()
->where('template', '=', true)
->orderBy('name', 'asc')
->get();
return view('books.edit', ['book' => $book, 'current' => $book, 'templates' => $templates]);
}
/**
@ -171,6 +184,7 @@ class BookController extends Controller
'description' => ['string', 'max:1000'],
'image' => array_merge(['nullable'], $this->getImageValidationRules()),
'tags' => ['array'],
'default_template' => ['nullable', 'exists:pages,id'],
]);
if ($request->has('image_reset')) {

View file

@ -0,0 +1,32 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class AddDefaultTemplateToBooks extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('books', function (Blueprint $table) {
$table->integer('default_template')->nullable();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('books', function (Blueprint $table) {
$table->dropColumn('default_template');
});
}
}

View file

@ -328,6 +328,8 @@ return [
'templates_replace_content' => 'Replace page content',
'templates_append_content' => 'Append to page content',
'templates_prepend_content' => 'Prepend to page content',
'default_template' => 'Default Page Template',
'default_template_explain' => "Assign a default template that will be used for all new pages in this book.",
// Profile View
'profile_user_for_x' => 'User for :time',

View file

@ -28,7 +28,10 @@
<main class="content-wrap card">
<h1 class="list-heading">{{ trans('entities.books_create') }}</h1>
<form action="{{ isset($bookshelf) ? $bookshelf->getUrl('/create-book') : url('/books') }}" method="POST" enctype="multipart/form-data">
@include('books.parts.form', ['returnLocation' => isset($bookshelf) ? $bookshelf->getUrl() : url('/books')])
@include('books.parts.form', [
'templates' => $templates,
'returnLocation' => isset($bookshelf) ? $bookshelf->getUrl() : url('/books')
])
</form>
</main>
</div>

View file

@ -18,7 +18,11 @@
<h1 class="list-heading">{{ trans('entities.books_edit') }}</h1>
<form action="{{ $book->getUrl() }}" method="POST" enctype="multipart/form-data">
<input type="hidden" name="_method" value="PUT">
@include('books.parts.form', ['model' => $book, 'returnLocation' => $book->getUrl()])
@include('books.parts.form', [
'model' => $book,
'templates' => $templates,
'returnLocation' => $book->getUrl()
])
</form>
</main>

View file

@ -35,6 +35,15 @@
</div>
</div>
<div class="form-group collapsible" component="collapsible" id="template-control">
<button refs="collapsible@trigger" type="button" class="collapse-title text-primary" aria-expanded="false">
<label for="template-manager">{{ trans('entities.default_template') }}</label>
</button>
<div refs="collapsible@content" class="collapse-content">
@include('entities.template-manager', ['entity' => $book ?? null, 'templates' => $templates])
</div>
</div>
<div class="form-group text-right">
<a href="{{ $returnLocation }}" class="button outline">{{ trans('common.cancel') }}</a>
<button type="submit" class="button">{{ trans('entities.books_save') }}</button>

View file

@ -0,0 +1,10 @@
<p class="text-muted small">
{!! nl2br(e(trans('entities.default_template_explain'))) !!}
</p>
<select name="default_template" id="default_template">
<option value="">---</option>
@foreach ($templates as $template)
<option @if(isset($entity) && $entity->default_template === $template->id) selected @endif value="{{ $template->id }}">{{ $template->name }}</option>
@endforeach
</select>