X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/ada7c83e96f35a6b484869d6d27939555e1942f7..refs/pull/684/head:/app/Entity.php

diff --git a/app/Entity.php b/app/Entity.php
index 35badb461..1ea4e8dac 100644
--- a/app/Entity.php
+++ b/app/Entity.php
@@ -1,9 +1,12 @@
 <?php namespace BookStack;
 
+use Illuminate\Database\Eloquent\Relations\MorphMany;
 
-abstract class Entity extends Ownable
+class Entity extends Ownable
 {
 
+    public $textField = 'description';
+
     /**
      * Compares this entity to another given entity.
      * Matches by comparing class and id.
@@ -24,7 +27,9 @@ abstract class Entity extends Ownable
     {
         $matches = [get_class($this), $this->id] === [get_class($entity), $entity->id];
 
-        if ($matches) return true;
+        if ($matches) {
+            return true;
+        }
 
         if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
             return $entity->book_id === $this->id;
@@ -43,7 +48,7 @@ abstract class Entity extends Ownable
      */
     public function activity()
     {
-        return $this->morphMany('BookStack\Activity', 'entity')->orderBy('created_at', 'desc');
+        return $this->morphMany(Activity::class, 'entity')->orderBy('created_at', 'desc');
     }
 
     /**
@@ -51,15 +56,44 @@ abstract class Entity extends Ownable
      */
     public function views()
     {
-        return $this->morphMany('BookStack\View', 'viewable');
+        return $this->morphMany(View::class, 'viewable');
+    }
+
+    /**
+     * Get the Tag models that have been user assigned to this entity.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function tags()
+    {
+        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)
+    {
+        $query = $this->morphMany(Comment::class, 'entity');
+        return $orderByCreated ? $query->orderBy('created_at', 'asc') : $query;
+    }
+
+    /**
+     * Get the related search terms.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function searchTerms()
+    {
+        return $this->morphMany(SearchTerm::class, 'entity');
     }
 
     /**
      * Get this entities restrictions.
      */
-    public function restrictions()
+    public function permissions()
     {
-        return $this->morphMany('BookStack\Restriction', 'restrictable');
+        return $this->morphMany(EntityPermission::class, 'restrictable');
     }
 
     /**
@@ -70,16 +104,17 @@ abstract class Entity extends Ownable
      */
     public function hasRestriction($role_id, $action)
     {
-        return $this->restrictions->where('role_id', $role_id)->where('action', $action)->count() > 0;
+        return $this->permissions()->where('role_id', '=', $role_id)
+            ->where('action', '=', $action)->count() > 0;
     }
 
     /**
-     * Get the entity permissions this is connected to.
+     * Get the entity jointPermissions this is connected to.
      * @return \Illuminate\Database\Eloquent\Relations\MorphMany
      */
-    public function permissions()
+    public function jointPermissions()
     {
-        return $this->morphMany(EntityPermission::class, 'entity');
+        return $this->morphMany(JointPermission::class, 'entity');
     }
 
     /**
@@ -102,6 +137,22 @@ abstract class Entity extends Ownable
         return strtolower(static::getClassName());
     }
 
+    /**
+     * Get an instance of an entity of the given type.
+     * @param $type
+     * @return Entity
+     */
+    public static function getEntityInstance($type)
+    {
+        $types = ['Page', 'Book', 'Chapter'];
+        $className = str_replace([' ', '-', '_'], '', ucwords($type));
+        if (!in_array($className, $types)) {
+            return null;
+        }
+
+        return app('BookStack\\' . $className);
+    }
+
     /**
      * Gets a limited-length version of the entities name.
      * @param int $length
@@ -109,65 +160,37 @@ abstract class Entity extends Ownable
      */
     public function getShortName($length = 25)
     {
-        if (strlen($this->name) <= $length) return $this->name;
+        if (strlen($this->name) <= $length) {
+            return $this->name;
+        }
         return substr($this->name, 0, $length - 3) . '...';
     }
 
     /**
-     * Perform a full-text search on this entity.
-     * @param string[] $fieldsToSearch
-     * @param string[] $terms
-     * @param string[] array $wheres
+     * Get the body text of this entity.
      * @return mixed
      */
-    public static function fullTextSearchQuery($fieldsToSearch, $terms, $wheres = [])
-    {
-        $exactTerms = [];
-        foreach ($terms as $key => $term) {
-            $term = htmlentities($term, ENT_QUOTES);
-            $term = preg_replace('/[+\-><\(\)~*\"@]+/', ' ', $term);
-            if (preg_match('/\s/', $term)) {
-                $exactTerms[] = '%' . $term . '%';
-                $term = '"' . $term . '"';
-            } else {
-                $term = '' . $term . '*';
-            }
-            if ($term !== '*') $terms[$key] = $term;
-        }
-        $termString = implode(' ', $terms);
-        $fields = implode(',', $fieldsToSearch);
-        $search = static::selectRaw('*, MATCH(name) AGAINST(? IN BOOLEAN MODE) AS title_relevance', [$termString]);
-        $search = $search->whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
-
-        // Ensure at least one exact term matches if in search
-        if (count($exactTerms) > 0) {
-            $search = $search->where(function ($query) use ($exactTerms, $fieldsToSearch) {
-                foreach ($exactTerms as $exactTerm) {
-                    foreach ($fieldsToSearch as $field) {
-                        $query->orWhere($field, 'like', $exactTerm);
-                    }
-                }
-            });
-        }
-
-        // Add additional where terms
-        foreach ($wheres as $whereTerm) {
-            $search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
-        }
-        // Load in relations
-        if (static::isA('page')) {
-            $search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
-        } else if (static::isA('chapter')) {
-            $search = $search->with('book');
-        }
-
-        return $search->orderBy('title_relevance', 'desc');
+    public function getText()
+    {
+        return $this->{$this->textField};
     }
 
     /**
-     * Get the url for this item.
+     * Return a generalised, common raw query that can be 'unioned' across entities.
      * @return string
      */
-    abstract public function getUrl();
+    public function entityRawQuery()
+    {
+        return '';
+    }
 
+    /**
+     * Get the url of this entity
+     * @param $path
+     * @return string
+     */
+    public function getUrl($path)
+    {
+        return '/';
+    }
 }