Add prev and next button to navigate through different pages

[bookstack] / app / Entities / Models / Entity.php

diff --git a/app/Entities/Models/Entity.php b/app/Entities/Models/Entity.php
index 29853fe309760807d3b1fa17606e996e1754ca9d..c6b2468b0814afd124d1c64a4e0f8b116b9ec8d5 100644 (file)
--- a/app/Entities/Models/Entity.php
+++ b/app/Entities/Models/Entity.php
@@ -1,4 +1,4 @@
-<?php namespace BookStack\Entities;
+<?php namespace BookStack\Entities\Models;

 
 use BookStack\Actions\Activity;
 use BookStack\Actions\Comment;
 
 use BookStack\Actions\Activity;
 use BookStack\Actions\Comment;


@@ -6,8 +6,12 @@ use BookStack\Actions\Tag;
 use BookStack\Actions\View;
 use BookStack\Auth\Permissions\EntityPermission;
 use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Actions\View;
 use BookStack\Auth\Permissions\EntityPermission;
 use BookStack\Auth\Permissions\JointPermission;

+use BookStack\Entities\Tools\SearchIndex;
+use BookStack\Entities\Tools\SlugGenerator;

 use BookStack\Facades\Permissions;
 use BookStack\Facades\Permissions;

-use BookStack\Ownable;
+use BookStack\Model;
+use BookStack\Traits\HasCreatorAndUpdater;
+use BookStack\Traits\HasOwner;

 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;


@@ -33,9 +37,11 @@ use Illuminate\Database\Eloquent\SoftDeletes;
  * @method static Builder withLastView()
  * @method static Builder withViewCount()
  */
  * @method static Builder withLastView()
  * @method static Builder withViewCount()
  */

-class Entity extends Ownable
+abstract class Entity extends Model

 {
     use SoftDeletes;
 {
     use SoftDeletes;

+    use HasCreatorAndUpdater;
+    use HasOwner;

 
     /**
      * @var string - Name of property where the main text content is found
 
     /**
      * @var string - Name of property where the main text content is found


@@ -50,7 +56,7 @@ class Entity extends Ownable
     /**
      * Get the entities that are visible to the current user.
      */
     /**
      * Get the entities that are visible to the current user.
      */

-    public function scopeVisible(Builder $query)
+    public function scopeVisible(Builder $query): Builder

     {
         return $this->scopeHasPermission($query, 'view');
     }
     {
         return $this->scopeHasPermission($query, 'view');
     }


@@ -92,24 +98,18 @@ class Entity extends Ownable
     /**
      * Compares this entity to another given entity.
      * Matches by comparing class and id.
     /**
      * Compares this entity to another given entity.
      * Matches by comparing class and id.

-     * @param $entity
-     * @return bool

      */
      */

-    public function matches($entity)
+    public function matches(Entity $entity): bool

     {
         return [get_class($this), $this->id] === [get_class($entity), $entity->id];
     }
 
     /**
     {
         return [get_class($this), $this->id] === [get_class($entity), $entity->id];
     }
 
     /**

-     * Checks if an entity matches or contains another given entity.
-     * @param Entity $entity
-     * @return bool
+     * Checks if the current entity matches or contains the given.

      */
      */

-    public function matchesOrContains(Entity $entity)
+    public function matchesOrContains(Entity $entity): bool

     {
     {

-        $matches = [get_class($this), $this->id] === [get_class($entity), $entity->id];
-
-        if ($matches) {
+        if ($this->matches($entity)) {

             return true;
         }
 
             return true;
         }
 


@@ -126,9 +126,8 @@ class Entity extends Ownable
 
     /**
      * Gets the activity objects for this entity.
 
     /**
      * Gets the activity objects for this entity.

-     * @return MorphMany

      */
      */

-    public function activity()
+    public function activity(): MorphMany

     {
         return $this->morphMany(Activity::class, 'entity')
             ->orderBy('created_at', 'desc');
     {
         return $this->morphMany(Activity::class, 'entity')
             ->orderBy('created_at', 'desc');


@@ -137,26 +136,23 @@ class Entity extends Ownable
     /**
      * Get View objects for this entity.
      */
     /**
      * Get View objects for this entity.
      */

-    public function views()
+    public function views(): MorphMany

     {
         return $this->morphMany(View::class, 'viewable');
     }
 
     /**
      * Get the Tag models that have been user assigned to this entity.
     {
         return $this->morphMany(View::class, 'viewable');
     }
 
     /**
      * Get the Tag models that have been user assigned to this entity.

-     * @return MorphMany

      */
      */

-    public function tags()
+    public function tags(): MorphMany

     {
         return $this->morphMany(Tag::class, 'entity')->orderBy('order', 'asc');
     }
 
     /**
      * Get the comments for an entity
     {
         return $this->morphMany(Tag::class, 'entity')->orderBy('order', 'asc');
     }
 
     /**
      * Get the comments for an entity

-     * @param bool $orderByCreated
-     * @return MorphMany

      */
      */

-    public function comments($orderByCreated = true)
+    public function comments(bool $orderByCreated = true): MorphMany

     {
         $query = $this->morphMany(Comment::class, 'entity');
         return $orderByCreated ? $query->orderBy('created_at', 'asc') : $query;
     {
         $query = $this->morphMany(Comment::class, 'entity');
         return $orderByCreated ? $query->orderBy('created_at', 'asc') : $query;


@@ -164,9 +160,8 @@ class Entity extends Ownable
 
     /**
      * Get the related search terms.
 
     /**
      * Get the related search terms.

-     * @return MorphMany

      */
      */

-    public function searchTerms()
+    public function searchTerms(): MorphMany

     {
         return $this->morphMany(SearchTerm::class, 'entity');
     }
     {
         return $this->morphMany(SearchTerm::class, 'entity');
     }


@@ -174,18 +169,15 @@ class Entity extends Ownable
     /**
      * Get this entities restrictions.
      */
     /**
      * Get this entities restrictions.
      */

-    public function permissions()
+    public function permissions(): MorphMany

     {
         return $this->morphMany(EntityPermission::class, 'restrictable');
     }
 
     /**
      * Check if this entity has a specific restriction set against it.
     {
         return $this->morphMany(EntityPermission::class, 'restrictable');
     }
 
     /**
      * Check if this entity has a specific restriction set against it.

-     * @param $role_id
-     * @param $action
-     * @return bool

      */
      */

-    public function hasRestriction($role_id, $action)
+    public function hasRestriction(int $role_id, string $action): bool

     {
         return $this->permissions()->where('role_id', '=', $role_id)
             ->where('action', '=', $action)->count() > 0;
     {
         return $this->permissions()->where('role_id', '=', $role_id)
             ->where('action', '=', $action)->count() > 0;


@@ -217,28 +209,12 @@ class Entity extends Ownable
     }
 
     /**
     }
 
     /**

-     * Get entity type.
-     * @return mixed
-     */
-    public static function getType()
-    {
-        return strtolower(static::getClassName());
-    }
-
-    /**
-     * Get an instance of an entity of the given type.
-     * @param $type
-     * @return Entity
+     * Get the entity type as a simple lowercase word.

      */
      */

-    public static function getEntityInstance($type)
+    public static function getType(): string

     {
     {

-        $types = ['Page', 'Book', 'Chapter', 'Bookshelf'];
-        $className = str_replace([' ', '-', '_'], '', ucwords($type));
-        if (!in_array($className, $types)) {
-            return null;
-        }
-
-        return app('BookStack\\Entities\\' . $className);
+        $className = array_slice(explode('\\', static::class), -1, 1)[0];
+        return strtolower($className);

     }
 
     /**
     }
 
     /**


@@ -254,36 +230,30 @@ class Entity extends Ownable
 
     /**
      * Get the body text of this entity.
 
     /**
      * Get the body text of this entity.

-     * @return mixed

      */
      */

-    public function getText()
+    public function getText(): string

     {
     {

-        return $this->{$this->textField};
+        return $this->{$this->textField} ?? '';

     }
 
     /**
      * Get an excerpt of this entity's descriptive content to the specified length.
     }
 
     /**
      * Get an excerpt of this entity's descriptive content to the specified length.

-     * @param int $length
-     * @return mixed

      */
      */

-    public function getExcerpt(int $length = 100)
+    public function getExcerpt(int $length = 100): string

     {
         $text = $this->getText();
     {
         $text = $this->getText();

+

         if (mb_strlen($text) > $length) {
             $text = mb_substr($text, 0, $length-3) . '...';
         }
         if (mb_strlen($text) > $length) {
             $text = mb_substr($text, 0, $length-3) . '...';
         }

+

         return trim($text);
     }
 
     /**
      * Get the url of this entity
         return trim($text);
     }
 
     /**
      * Get the url of this entity

-     * @param $path
-     * @return string

      */
      */

-    public function getUrl($path = '/')
-    {
-        return $path;
-    }
+    abstract public function getUrl(string $path = '/'): string;

 
     /**
      * Get the parent entity if existing.
 
     /**
      * Get the parent entity if existing.


@@ -315,8 +285,7 @@ class Entity extends Ownable
      */
     public function indexForSearch()
     {
      */
     public function indexForSearch()
     {

-        $searchService = app()->make(SearchService::class);
-        $searchService->indexEntity(clone $this);
+        app(SearchIndex::class)->indexEntity(clone $this);

     }
 
     /**
     }
 
     /**