bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Started build of a new "Hacks" area

Browse source
This commit is contained in:
Dan Brown 2023-01-23 20:40:53 +00:00
commit 4e7a7984dd
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
4 changed files with 150 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

55
content/hacks/autosort-tagged-books/functions.php Normal file
View file

@ -0,0 +1,55 @@
<?php
use BookStack\Actions\ActivityType;
use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Page;
use BookStack\Facades\Theme;
use BookStack\Theming\ThemeEvents;
/**
* Auto-sort the contents of the given book.
* This sorts in name order, ascending, with chapters first.
*/
function autoSortBook(Book $book) {
$chapters = $book->chapters()->orderBy('name', 'asc')->get(['id', 'priority']);
$pages = $book->pages()->orderBy('name', 'asc')
->where('draft', '=', false)
->get(['id', 'priority']);
$chapterCount = $chapters->count();
foreach ($chapters as $index => $chapter) {
$chapter->priority = $index;
$chapter->save();
}
foreach ($pages as $index => $page) {
$page->priority = $chapterCount + $index;
$page->save();
}
}
// Listen to the activity logged theme event to run our custom logic
Theme::listen(ThemeEvents::ACTIVITY_LOGGED, function (string $type, $detail) {
// The activity events we're triggering sort upon.
$sortActivityTypes = [
ActivityType::PAGE_CREATE,
ActivityType::PAGE_UPDATE,
ActivityType::CHAPTER_CREATE,
ActivityType::CHAPTER_UPDATE,
];
// The name of the book-level tag which indicates auto-sort should run.
// Set to empty string ('') to run for all books.
$tagName = 'autosort';
// If it's one of our activity types, correctly tagged, run the auto-sort logic
if (in_array($type, $sortActivityTypes) && ($detail instanceof Page || $detail instanceof Chapter)) {
$book = $detail->book;
if (empty($tagName) || $book->tags()->where('name', '=', $tagName)->exists()) {
autoSortBook($detail->book);
}
}
});

18
content/hacks/autosort-tagged-books/index.md Normal file
View file

@ -0,0 +1,18 @@
+++
title = "Autosort Tagged Books"
author = "@ssddanbrown"
date = 2023-01-23T20:00:00Z
updated = 2023-01-23T20:00:00Z
tested = "v22.11.1"
+++
This is a hack to BookStack to enable auto-sorting of book chapters and pages upon page or chapter create/update. It sorts by name, ascending, with chapters first. By default it will run for any book with an `Autosort` tag assigned.
#### Options
Customize the tag name, if desired, by tweaking the string at around line 45. Set this to empty to run for all books.
#### Code
{{<hack file="functions.php" type="logical">}}