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

   1 <?php namespace BookStack;
   2
   3
   4 class Page extends Entity
   5 {
   6     protected $fillable = ['name', 'html', 'priority', 'markdown'];
   7
   8     protected $simpleAttributes = ['name', 'id', 'slug'];
   9
  10     protected $with = ['book'];
  11
  12     protected $fieldsToSearch = ['name', 'text'];
  13
  14     /**
  15      * Converts this page into a simplified array.
  16      * @return mixed
  17      */
  18     public function toSimpleArray()
  19     {
  20         $array = array_intersect_key($this->toArray(), array_flip($this->simpleAttributes));
  21         $array['url'] = $this->getUrl();
  22         return $array;
  23     }
  24
  25     /**
  26      * Get the book this page sits in.
  27      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
  28      */
  29     public function book()
  30     {
  31         return $this->belongsTo(Book::class);
  32     }
  33
  34     /**
  35      * Get the chapter that this page is in, If applicable.
  36      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
  37      */
  38     public function chapter()
  39     {
  40         return $this->belongsTo(Chapter::class);
  41     }
  42
  43     /**
  44      * Get the comments in the page.
  45      * @return \Illuminate\Database\Eloquent\Relations\HasMany
  46      */
  47     public function comment()
  48     {
  49         return $this->hasMany(Comment::class);
  50     }
  51
  52     /**
  53      * Check if this page has a chapter.
  54      * @return bool
  55      */
  56     public function hasChapter()
  57     {
  58         return $this->chapter()->count() > 0;
  59     }
  60
  61     /**
  62      * Get the associated page revisions, ordered by created date.
  63      * @return mixed
  64      */
  65     public function revisions()
  66     {
  67         return $this->hasMany(PageRevision::class)->where('type', '=', 'version')->orderBy('created_at', 'desc');
  68     }
  69
  70     /**
  71      * Get the attachments assigned to this page.
  72      * @return \Illuminate\Database\Eloquent\Relations\HasMany
  73      */
  74     public function attachments()
  75     {
  76         return $this->hasMany(Attachment::class, 'uploaded_to')->orderBy('order', 'asc');
  77     }
  78
  79     /**
  80      * Get the url for this page.
  81      * @param string|bool $path
  82      * @return string
  83      */
  84     public function getUrl($path = false)
  85     {
  86         $bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug;
  87         $midText = $this->draft ? '/draft/' : '/page/';
  88         $idComponent = $this->draft ? $this->id : urlencode($this->slug);
  89
  90         if ($path !== false) {
  91             return baseUrl('/books/' . urlencode($bookSlug) . $midText . $idComponent . '/' . trim($path, '/'));
  92         }
  93
  94         return baseUrl('/books/' . urlencode($bookSlug) . $midText . $idComponent);
  95     }
  96
  97     /**
  98      * Get an excerpt of this page's content to the specified length.
  99      * @param int $length
 100      * @return mixed
 101      */
 102     public function getExcerpt($length = 100)
 103     {
 104         $text = strlen($this->text) > $length ? substr($this->text, 0, $length-3) . '...' : $this->text;
 105         return mb_convert_encoding($text, 'UTF-8');
 106     }
 107
 108 }