namespace BookStack\Entities\Models;
use BookStack\Entities\Tools\PageContent;
+use BookStack\Facades\Permissions;
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'];
+ public static $listAttributes = ['name', 'id', 'slug', 'book_id', 'chapter_id', 'draft', 'template', 'text', 'created_at', 'updated_at', 'priority'];
+ public static $contentAttributes = ['name', 'id', 'slug', 'book_id', 'chapter_id', 'draft', 'template', 'html', 'text', 'created_at', 'updated_at', 'priority'];
+
+ protected $fillable = ['name', 'priority'];
public $textField = 'text';
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.
*
/**
* Check if this page has a chapter.
- *
- * @return bool
*/
- public function hasChapter()
+ public function hasChapter(): bool
{
return $this->chapter()->count() > 0;
}
->orderBy('id', 'desc');
}
+ /**
+ * Get the current revision for the page if existing.
+ *
+ * @return PageRevision|null
+ */
+ 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.
/**
* 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, '/'),
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']));