BookStack Code Mirror - bookstack/blob - app/Book.php

   1 <?php namespace BookStack;
   2
   3 class Book extends Entity
   4 {
   5
   6     protected $fillable = ['name', 'description', 'image_id'];
   7
   8     /**
   9      * Get the url for this book.
  10      * @param string|bool $path
  11      * @return string
  12      */
  13     public function getUrl($path = false)
  14     {
  15         if ($path !== false) {
  16             return baseUrl('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
  17         }
  18         return baseUrl('/books/' . urlencode($this->slug));
  19     }
  20
  21     /**
  22      * Returns book cover image, if book cover not exists return default cover image.
  23      * @param int $width - Width of the image
  24      * @param int $height - Height of the image
  25      * @return string
  26      */
  27     public function getBookCover($width = 440, $height = 250)
  28     {
  29         $default = baseUrl('/book_default_cover.png');
  30         if (!$this->image_id) {
  31             return $default;
  32         }
  33
  34         try {
  35             $cover = $this->cover ? baseUrl($this->cover->getThumb($width, $height, false)) : $default;
  36         } catch (\Exception $err) {
  37             $cover = $default;
  38         }
  39         return $cover;
  40     }
  41
  42     /**
  43      * Get the cover image of the book
  44      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
  45      */
  46     public function cover()
  47     {
  48         return $this->belongsTo(Image::class, 'image_id');
  49     }
  50     /*
  51      * Get the edit url for this book.
  52      * @return string
  53      */
  54     public function getEditUrl()
  55     {
  56         return $this->getUrl() . '/edit';
  57     }
  58
  59     /**
  60      * Get all pages within this book.
  61      * @return \Illuminate\Database\Eloquent\Relations\HasMany
  62      */
  63     public function pages()
  64     {
  65         return $this->hasMany(Page::class);
  66     }
  67
  68     /**
  69      * Get all chapters within this book.
  70      * @return \Illuminate\Database\Eloquent\Relations\HasMany
  71      */
  72     public function chapters()
  73     {
  74         return $this->hasMany(Chapter::class);
  75     }
  76
  77     /**
  78      * Get an excerpt of this book's description to the specified length or less.
  79      * @param int $length
  80      * @return string
  81      */
  82     public function getExcerpt($length = 100)
  83     {
  84         $description = $this->description;
  85         return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
  86     }
  87
  88     /**
  89      * Return a generalised, common raw query that can be 'unioned' across entities.
  90      * @return string
  91      */
  92     public function entityRawQuery()
  93     {
  94         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";
  95     }
  96 }