X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/fd1a0dceb25b9b2a2707df754e9ff56b96de34b6..refs/pull/422/head:/app/Page.php diff --git a/app/Page.php b/app/Page.php index 449cb15c4..c9823e7e4 100644 --- a/app/Page.php +++ b/app/Page.php @@ -1,15 +1,19 @@ -toArray(), array_flip($this->simpleAttributes)); @@ -17,19 +21,88 @@ class Page extends Model return $array; } + /** + * Get the book this page sits in. + * @return \Illuminate\Database\Eloquent\Relations\BelongsTo + */ public function book() { - return $this->belongsTo('Oxbow\Book'); + return $this->belongsTo(Book::class); + } + + /** + * Get the chapter that this page is in, If applicable. + * @return \Illuminate\Database\Eloquent\Relations\BelongsTo + */ + public function chapter() + { + return $this->belongsTo(Chapter::class); + } + + /** + * Check if this page has a chapter. + * @return bool + */ + public function hasChapter() + { + return $this->chapter()->count() > 0; + } + + /** + * Get the associated page revisions, ordered by created date. + * @return mixed + */ + public function revisions() + { + return $this->hasMany(PageRevision::class)->where('type', '=', 'version')->orderBy('created_at', 'desc'); } - public function parent() + /** + * Get the attachments assigned to this page. + * @return \Illuminate\Database\Eloquent\Relations\HasMany + */ + public function attachments() { - return $this->belongsTo('Oxbow\Page', 'page_id'); + return $this->hasMany(Attachment::class, 'uploaded_to')->orderBy('order', 'asc'); } - public function getUrl() + /** + * Get the url for this page. + * @param string|bool $path + * @return string + */ + public function getUrl($path = false) { - return '/books/' . $this->book->slug . '/page/' . $this->slug; + $bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug; + $midText = $this->draft ? '/draft/' : '/page/'; + $idComponent = $this->draft ? $this->id : urlencode($this->slug); + + if ($path !== false) { + return baseUrl('/books/' . urlencode($bookSlug) . $midText . $idComponent . '/' . trim($path, '/')); + } + + return baseUrl('/books/' . urlencode($bookSlug) . $midText . $idComponent); + } + + /** + * Get an excerpt of this page's content to the specified length. + * @param int $length + * @return mixed + */ + public function getExcerpt($length = 100) + { + $text = strlen($this->text) > $length ? substr($this->text, 0, $length-3) . '...' : $this->text; + return mb_convert_encoding($text, 'UTF-8'); + } + + /** + * Return a generalised, common raw query that can be 'unioned' across entities. + * @param bool $withContent + * @return string + */ + public function entityRawQuery($withContent = false) + { $htmlQuery = $withContent ? 'html' : "'' as html"; + return "'BookStack\\\\Page' as entity_type, id, id as entity_id, slug, name, {$this->textField} as text, {$htmlQuery}, book_id, priority, chapter_id, draft, created_by, updated_by, updated_at, created_at"; } }