replace GPL diff lib with MIT lib

[bookstack] / app / Page.php

diff --git a/app/Page.php b/app/Page.php
index 3dc3b0256cebdcb5a595136704ba4ac825fda6ab..c6978d34ba935a163fe3b037037e77e2bca94f2a 100644 (file)
--- a/app/Page.php
+++ b/app/Page.php
@@ -7,6 +7,10 @@ class Page extends Entity
 
     protected $simpleAttributes = ['name', 'id', 'slug'];
 
+    /**
+     * Converts this page into a simplified array.
+     * @return mixed
+     */
     public function toSimpleArray()
     {
         $array = array_intersect_key($this->toArray(), array_flip($this->simpleAttributes));
@@ -14,26 +18,46 @@ class Page extends Entity
         return $array;
     }
 
+    /**
+     * Get the book this page sits in.
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
     public function book()
     {
-        return $this->belongsTo('BookStack\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('BookStack\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('BookStack\PageRevision')->where('type', '=', 'version')->orderBy('created_at', 'desc');
+        return $this->hasMany(PageRevision::class)->where('type', '=', 'version')->orderBy('created_at', 'desc');
     }
 
+    /**
+     * Get the url for this page.
+     * @return string
+     */
     public function getUrl()
     {
         $bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug;
@@ -42,6 +66,11 @@ class Page extends Entity
         return '/books/' . $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;