Added migration file.

[bookstack] / app / Entity.php

diff --git a/app/Entity.php b/app/Entity.php
index d2c5bd5c182caeb71d9b1c444889d2d2509e5926..e5dd04bf28bdb01d30690c18e5b9a2b6986a7929 100644 (file)
--- a/app/Entity.php
+++ b/app/Entity.php
@@ -1,47 +1,106 @@
-<?php
+<?php namespace BookStack;

 
 

-namespace Oxbow;

 
 

-use Illuminate\Database\Eloquent\Model;
-
-abstract class Entity extends Model
+class Entity extends Ownable

 {
 {

+
+    public $textField = 'description';
+

     /**
     /**

-     * Relation for the user that created this entity.
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * Compares this entity to another given entity.
+     * Matches by comparing class and id.
+     * @param $entity
+     * @return bool

      */
      */

-    public function createdBy()
+    public function matches($entity)

     {
     {

-        return $this->belongsTo('Oxbow\User', 'created_by');
+        return [get_class($this), $this->id] === [get_class($entity), $entity->id];

     }
 
     /**
     }
 
     /**

-     * Relation for the user that updated this entity.
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * Checks if an entity matches or contains another given entity.
+     * @param Entity $entity
+     * @return bool

      */
      */

-    public function updatedBy()
+    public function matchesOrContains(Entity $entity)

     {
     {

-        return $this->belongsTo('Oxbow\User', 'updated_by');
+        $matches = [get_class($this), $this->id] === [get_class($entity), $entity->id];
+
+        if ($matches) return true;
+
+        if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
+            return $entity->book_id === $this->id;
+        }
+
+        if ($entity->isA('page') && $this->isA('chapter')) {
+            return $entity->chapter_id === $this->id;
+        }
+
+        return false;

     }
 
     /**
     }
 
     /**

-     * Compares this entity to another given entity.
-     * Matches by comparing class and id.
-     * @param $entity
+     * Gets the activity objects for this entity.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function activity()
+    {
+        return $this->morphMany(Activity::class, 'entity')->orderBy('created_at', 'desc');
+    }
+
+    /**
+     * Get View objects for this entity.
+     */
+    public function views()
+    {
+        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 related search terms.
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function searchTerms()
+    {
+        return $this->morphMany(SearchTerm::class, 'entity');
+    }
+
+    /**
+     * Get this entities restrictions.
+     */
+    public function permissions()
+    {
+        return $this->morphMany(EntityPermission::class, 'restrictable');
+    }
+
+    /**
+     * Check if this entity has a specific restriction set against it.
+     * @param $role_id
+     * @param $action

      * @return bool
      */
      * @return bool
      */

-    public function matches($entity)
+    public function hasRestriction($role_id, $action)

     {
     {

-        return [get_class($this), $this->id] === [get_class($entity), $entity->id];
+        return $this->permissions()->where('role_id', '=', $role_id)
+            ->where('action', '=', $action)->count() > 0;

     }
 
     /**
     }
 
     /**

-     * Gets the activity for this entity.
+     * Get the entity jointPermissions this is connected to.

      * @return \Illuminate\Database\Eloquent\Relations\MorphMany
      */
      * @return \Illuminate\Database\Eloquent\Relations\MorphMany
      */

-    public function activity()
+    public function jointPermissions()

     {
     {

-        return $this->morphMany('Oxbow\Activity', 'entity')->orderBy('created_at', 'desc');
+        return $this->morphMany(JointPermission::class, 'entity');

     }
 
     /**
     }
 
     /**


@@ -50,46 +109,67 @@ abstract class Entity extends Model
      * @param $type
      * @return bool
      */
      * @param $type
      * @return bool
      */

-    public function isA($type)
+    public static function isA($type)

     {
     {

-        return $this->getName() === strtolower($type);
+        return static::getType() === strtolower($type);

     }
 
     /**
     }
 
     /**

-     * Gets the class name.
+     * 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
+     */
+    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

      * @return string
      */
      * @return string
      */

-    public function getName()
+    public function getShortName($length = 25)

     {
     {

-        $fullClassName = get_class($this);
-        return strtolower(array_slice(explode('\\', $fullClassName), -1, 1)[0]);
+        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
      */
      * @return mixed
      */

-    public static function fullTextSearch($fieldsToSearch, $terms, $wheres = [])
+    public function getText()

     {
     {

-        $termString = '';
-        foreach ($terms as $term) {
-            $termString .= $term . '* ';
-        }
-        $fields = implode(',', $fieldsToSearch);
-        $search = static::whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
-        foreach ($wheres as $whereTerm) {
-            $search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
-        }
-        return $search->get();
+        return $this->{$this->textField};

     }
 
     /**
     }
 
     /**

-     * Get the url for this item.
+     * Return a generalised, common raw query that can be 'unioned' across entities.
+     * @return string
+     */
+    public function entityRawQuery(){return '';}
+
+    /**
+     * Get the url of this entity
+     * @param $path

      * @return string
      */
      * @return string
      */

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

 
 }
 
 }