X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/22f8a408fa127818856f2e071c5e83a43ab672c0..refs/pull/263/head:/app/Book.php

diff --git a/app/Book.php b/app/Book.php
index de1841459..91f74ca64 100644
--- a/app/Book.php
+++ b/app/Book.php
@@ -1,35 +1,59 @@
-<?php
-
-namespace BookStack;
+<?php namespace BookStack;
 
 class Book extends Entity
 {
 
     protected $fillable = ['name', 'description'];
 
-    public function getUrl()
+    /**
+     * Get the url for this book.
+     * @param string|bool $path
+     * @return string
+     */
+    public function getUrl($path = false)
     {
-        return '/books/' . $this->slug;
+        if ($path !== false) {
+            return baseUrl('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
+        }
+        return baseUrl('/books/' . urlencode($this->slug));
     }
 
+    /*
+     * Get the edit url for this book.
+     * @return string
+     */
     public function getEditUrl()
     {
         return $this->getUrl() . '/edit';
     }
 
+    /**
+     * Get all pages within this book.
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
     public function pages()
     {
-        return $this->hasMany('BookStack\Page');
+        return $this->hasMany(Page::class);
     }
 
+    /**
+     * Get all chapters within this book.
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
     public function chapters()
     {
-        return $this->hasMany('BookStack\Chapter');
+        return $this->hasMany(Chapter::class);
     }
 
+    /**
+     * Get an excerpt of this book's description to the specified length or less.
+     * @param int $length
+     * @return string
+     */
     public function getExcerpt($length = 100)
     {
-        return strlen($this->description) > $length ? substr($this->description, 0, $length-3) . '...' : $this->description;
+        $description = $this->description;
+        return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
     }
 
 }