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

   1 <?php namespace BookStack\Entities\Models;
   2
   3 use BookStack\Entities\Tools\PageContent;
   4 use BookStack\Uploads\Attachment;
   5 use Illuminate\Database\Eloquent\Builder;
   6 use Illuminate\Database\Eloquent\Collection;
   7 use Illuminate\Database\Eloquent\Relations\BelongsTo;
   8 use Illuminate\Database\Eloquent\Relations\HasMany;
   9 use Permissions;
  10
  11 /**
  12  * Class Page
  13  * @property int $chapter_id
  14  * @property string $html
  15  * @property string $markdown
  16  * @property string $text
  17  * @property bool $template
  18  * @property bool $draft
  19  * @property int $revision_count
  20  * @property Chapter $chapter
  21  * @property Collection $attachments
  22  */
  23 class Page extends BookChild
  24 {
  25     protected $fillable = ['name', 'priority', 'markdown'];
  26
  27     protected $simpleAttributes = ['name', 'id', 'slug'];
  28
  29     public $textField = 'text';
  30
  31     protected $hidden = ['html', 'markdown', 'text', 'restricted', 'pivot', 'deleted_at'];
  32
  33     protected $casts = [
  34         'draft' => 'boolean',
  35         'template' => 'boolean',
  36     ];
  37
  38     /**
  39      * Get the entities that are visible to the current user.
  40      */
  41     public function scopeVisible(Builder $query): Builder
  42     {
  43         $query = Permissions::enforceDraftVisibilityOnQuery($query);
  44         return parent::scopeVisible($query);
  45     }
  46
  47     /**
  48      * Converts this page into a simplified array.
  49      * @return mixed
  50      */
  51     public function toSimpleArray()
  52     {
  53         $array = array_intersect_key($this->toArray(), array_flip($this->simpleAttributes));
  54         $array['url'] = $this->getUrl();
  55         return $array;
  56     }
  57
  58     /**
  59      * Get the chapter that this page is in, If applicable.
  60      * @return BelongsTo
  61      */
  62     public function chapter()
  63     {
  64         return $this->belongsTo(Chapter::class);
  65     }
  66
  67     /**
  68      * Check if this page has a chapter.
  69      * @return bool
  70      */
  71     public function hasChapter()
  72     {
  73         return $this->chapter()->count() > 0;
  74     }
  75
  76     /**
  77      * Get the associated page revisions, ordered by created date.
  78      * Only provides actual saved page revision instances, Not drafts.
  79      */
  80     public function revisions(): HasMany
  81     {
  82         return $this->allRevisions()
  83             ->where('type', '=', 'version')
  84             ->orderBy('created_at', 'desc')
  85             ->orderBy('id', 'desc');
  86     }
  87
  88     /**
  89      * Get all revision instances assigned to this page.
  90      * Includes all types of revisions.
  91      */
  92     public function allRevisions(): HasMany
  93     {
  94         return $this->hasMany(PageRevision::class);
  95     }
  96
  97     /**
  98      * Get the attachments assigned to this page.
  99      * @return HasMany
 100      */
 101     public function attachments()
 102     {
 103         return $this->hasMany(Attachment::class, 'uploaded_to')->orderBy('order', 'asc');
 104     }
 105
 106     /**
 107      * Get the url of this page.
 108      */
 109     public function getUrl($path = ''): string
 110     {
 111         $parts = [
 112             'books',
 113             urlencode($this->getAttribute('bookSlug') ?? $this->book->slug),
 114             $this->draft ? 'draft' : 'page',
 115             $this->draft ? $this->id : urlencode($this->slug),
 116             trim($path, '/'),
 117         ];
 118
 119         return url('/' . implode('/', $parts));
 120     }
 121
 122     /**
 123      * Get the current revision for the page if existing
 124      * @return PageRevision|null
 125      */
 126     public function getCurrentRevision()
 127     {
 128         return $this->revisions()->first();
 129     }
 130
 131     /**
 132      * Get this page for JSON display.
 133      */
 134     public function forJsonDisplay(): Page
 135     {
 136         $refreshed = $this->refresh()->unsetRelations()->load(['tags', 'createdBy', 'updatedBy', 'ownedBy']);
 137         $refreshed->setHidden(array_diff($refreshed->getHidden(), ['html', 'markdown']));
 138         $refreshed->html = (new PageContent($refreshed))->render();
 139         return $refreshed;
 140     }
 141
 142     /**
 143      * Returns URL to a cover image for the page.
 144      */
 145     public function getCoverImage()
 146     {
 147         //$default = $this->book->getBookCover();
 148         $default = url('/logo.png');
 149
 150         $firstImage = (new PageContent($this))->fetchFirstImage();
 151
 152         try {
 153             $cover = $firstImage ? $firstImage : $default;
 154         } catch (\Exception $err) {
 155             $cover = $default;
 156         }
 157         return $cover;
 158     }
 159
 160 }