namespace BookStack\Entities\Models;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Collection;
* Class Chapter.
*
* @property Collection<Page> $pages
- * @property string $description
+ * @property ?int $default_template_id
+ * @property ?Page $defaultTemplate
*/
class Chapter extends BookChild
{
public float $searchFactor = 1.2;
protected $fillable = ['name', 'description', 'priority'];
- protected $hidden = ['pivot', 'deleted_at'];
+ protected $hidden = ['pivot', 'deleted_at', 'description_html'];
/**
* Get the pages that this chapter contains.
return url('/' . implode('/', $parts));
}
+ /**
+ * Get the Page that is used as default template for newly created pages within this Chapter.
+ */
+ public function defaultTemplate(): BelongsTo
+ {
+ return $this->belongsTo(Page::class, 'default_template_id');
+ }
+
/**
* Get the visible pages in this chapter.
*/
->orderBy('priority', 'asc')
->get();
}
-
- /**
- * Get a visible chapter by its book and page slugs.
- * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
- */
- public static function getBySlugs(string $bookSlug, string $chapterSlug): self
- {
- return static::visible()->whereSlugs($bookSlug, $chapterSlug)->firstOrFail();
- }
}