147 lines
3.9 KiB
PHP
147 lines
3.9 KiB
PHP
<?php
|
|
|
|
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 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 string $editor
|
|
* @property Chapter $chapter
|
|
* @property Collection $attachments
|
|
* @property Collection $revisions
|
|
* @property PageRevision $currentRevision
|
|
*/
|
|
class Page extends BookChild
|
|
{
|
|
use HasFactory;
|
|
|
|
protected $fillable = ['name', 'priority'];
|
|
|
|
public string $textField = 'text';
|
|
public string $htmlField = 'html';
|
|
|
|
protected $hidden = ['html', 'markdown', 'text', 'pivot', 'deleted_at'];
|
|
|
|
protected $casts = [
|
|
'draft' => 'boolean',
|
|
'template' => 'boolean',
|
|
];
|
|
|
|
/**
|
|
* Get the entities that are visible to the current user.
|
|
*/
|
|
public function scopeVisible(Builder $query): Builder
|
|
{
|
|
$query = app()->make(PermissionApplicator::class)->restrictDraftsOnPageQuery($query);
|
|
|
|
return parent::scopeVisible($query);
|
|
}
|
|
|
|
/**
|
|
* Get the chapter that this page is in, If applicable.
|
|
*
|
|
* @return BelongsTo
|
|
*/
|
|
public function chapter()
|
|
{
|
|
return $this->belongsTo(Chapter::class);
|
|
}
|
|
|
|
/**
|
|
* Check if this page has a chapter.
|
|
*/
|
|
public function hasChapter(): bool
|
|
{
|
|
return $this->chapter()->count() > 0;
|
|
}
|
|
|
|
/**
|
|
* Get the associated page revisions, ordered by created date.
|
|
* Only provides actual saved page revision instances, Not drafts.
|
|
*/
|
|
public function revisions(): HasMany
|
|
{
|
|
return $this->allRevisions()
|
|
->where('type', '=', 'version')
|
|
->orderBy('created_at', 'desc')
|
|
->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.
|
|
*/
|
|
public function allRevisions(): HasMany
|
|
{
|
|
return $this->hasMany(PageRevision::class);
|
|
}
|
|
|
|
/**
|
|
* Get the attachments assigned to this page.
|
|
*
|
|
* @return HasMany
|
|
*/
|
|
public function attachments()
|
|
{
|
|
return $this->hasMany(Attachment::class, 'uploaded_to')->orderBy('order', 'asc');
|
|
}
|
|
|
|
/**
|
|
* Get the url of this page.
|
|
*/
|
|
public function getUrl(string $path = ''): string
|
|
{
|
|
$parts = [
|
|
'books',
|
|
urlencode($this->book_slug ?? $this->book->slug),
|
|
$this->draft ? 'draft' : 'page',
|
|
$this->draft ? $this->id : urlencode($this->slug),
|
|
trim($path, '/'),
|
|
];
|
|
|
|
return url('/' . implode('/', $parts));
|
|
}
|
|
|
|
/**
|
|
* Get this page for JSON display.
|
|
*/
|
|
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;
|
|
}
|
|
}
|