X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/b54ef3bb4b7c51f43382660d497c265b10de1361..refs/pull/435/head:/app/Book.php

diff --git a/app/Book.php b/app/Book.php
index ccf02e4f3..06c00945d 100644
--- a/app/Book.php
+++ b/app/Book.php
@@ -1,40 +1,68 @@
-<?php
+<?php namespace BookStack;
 
-namespace Oxbow;
-
-use Illuminate\Database\Eloquent\Model;
-
-class Book extends Model
+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('Oxbow\Page');
+        return $this->hasMany(Page::class);
     }
 
+    /**
+     * Get all chapters within this book.
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
     public function chapters()
     {
-        return $this->hasMany('Oxbow\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)
+    {
+        $description = $this->description;
+        return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
     }
 
-    public function children()
+    /**
+     * Return a generalised, common raw query that can be 'unioned' across entities.
+     * @return string
+     */
+    public function entityRawQuery()
     {
-        $pages = $this->pages()->where('chapter_id', '=', 0)->get();
-        $chapters = $this->chapters()->get();
-        $children = $pages->merge($chapters);
-        return $children->sortBy('priority');
+        return "'BookStack\\\\Book' as entity_type, id, id as entity_id, slug, name, {$this->textField} as text,'' as html, '0' as book_id, '0' as priority, '0' as chapter_id, '0' as draft, created_by, updated_by, updated_at, created_at";
     }
 
 }