X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/1c43602f4bed60a84f47735ca8bc4a399018e013..refs/pull/5721/head:/app/Entities/Models/Page.php diff --git a/app/Entities/Models/Page.php b/app/Entities/Models/Page.php index 123600539..499ef4d72 100644 --- a/app/Entities/Models/Page.php +++ b/app/Entities/Models/Page.php @@ -3,35 +3,42 @@ namespace BookStack\Entities\Models; use BookStack\Entities\Tools\PageContent; +use BookStack\Entities\Tools\PageEditorType; +use BookStack\Permissions\PermissionApplicator; use BookStack\Uploads\Attachment; use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Collection; +use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\HasMany; -use Permissions; +use Illuminate\Database\Eloquent\Relations\HasOne; /** * Class Page. * - * @property int $chapter_id - * @property string $html - * @property string $markdown - * @property string $text - * @property bool $template - * @property bool $draft - * @property int $revision_count - * @property Chapter $chapter - * @property Collection $attachments + * @property int $chapter_id + * @property string $html + * @property string $markdown + * @property string $text + * @property bool $template + * @property bool $draft + * @property int $revision_count + * @property string $editor + * @property Chapter $chapter + * @property Collection $attachments + * @property Collection $revisions + * @property PageRevision $currentRevision */ class Page extends BookChild { - protected $fillable = ['name', 'priority', 'markdown']; + use HasFactory; - protected $simpleAttributes = ['name', 'id', 'slug']; + protected $fillable = ['name', 'priority']; - public $textField = 'text'; + public string $textField = 'text'; + public string $htmlField = 'html'; - protected $hidden = ['html', 'markdown', 'text', 'restricted', 'pivot', 'deleted_at']; + protected $hidden = ['html', 'markdown', 'text', 'pivot', 'deleted_at']; protected $casts = [ 'draft' => 'boolean', @@ -43,24 +50,11 @@ class Page extends BookChild */ public function scopeVisible(Builder $query): Builder { - $query = Permissions::enforceDraftVisibilityOnQuery($query); + $query = app()->make(PermissionApplicator::class)->restrictDraftsOnPageQuery($query); return parent::scopeVisible($query); } - /** - * Converts this page into a simplified array. - * - * @return mixed - */ - public function toSimpleArray() - { - $array = array_intersect_key($this->toArray(), array_flip($this->simpleAttributes)); - $array['url'] = $this->getUrl(); - - return $array; - } - /** * Get the chapter that this page is in, If applicable. * @@ -73,10 +67,8 @@ class Page extends BookChild /** * Check if this page has a chapter. - * - * @return bool */ - public function hasChapter() + public function hasChapter(): bool { return $this->chapter()->count() > 0; } @@ -93,6 +85,17 @@ class Page extends BookChild ->orderBy('id', 'desc'); } + /** + * Get the current revision for the page if existing. + */ + public function currentRevision(): HasOne + { + return $this->hasOne(PageRevision::class) + ->where('type', '=', 'version') + ->orderBy('created_at', 'desc') + ->orderBy('id', 'desc'); + } + /** * Get all revision instances assigned to this page. * Includes all types of revisions. @@ -115,11 +118,11 @@ class Page extends BookChild /** * Get the url of this page. */ - public function getUrl($path = ''): string + public function getUrl(string $path = ''): string { $parts = [ 'books', - urlencode($this->getAttribute('bookSlug') ?? $this->book->slug), + urlencode($this->book_slug ?? $this->book->slug), $this->draft ? 'draft' : 'page', $this->draft ? $this->id : urlencode($this->slug), trim($path, '/'), @@ -128,23 +131,14 @@ class Page extends BookChild return url('/' . implode('/', $parts)); } - /** - * Get the current revision for the page if existing. - * - * @return PageRevision|null - */ - public function getCurrentRevision() - { - return $this->revisions()->first(); - } - /** * Get this page for JSON display. */ - public function forJsonDisplay(): Page + public function forJsonDisplay(): self { $refreshed = $this->refresh()->unsetRelations()->load(['tags', 'createdBy', 'updatedBy', 'ownedBy']); $refreshed->setHidden(array_diff($refreshed->getHidden(), ['html', 'markdown'])); + $refreshed->setAttribute('raw_html', $refreshed->html); $refreshed->html = (new PageContent($refreshed))->render(); return $refreshed;