X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/db3acabc662e976f253db47f82162c9f00667446..refs/pull/446/head:/app/Entity.php diff --git a/app/Entity.php b/app/Entity.php index 5ccc016a3..e5dd04bf2 100644 --- a/app/Entity.php +++ b/app/Entity.php @@ -1,13 +1,10 @@ -isA('chapter') && $this->isA('book')) { - return $entity->book_id === $this->id; - } - - if ($entity->isA('page') && $this->isA('book')) { + if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) { return $entity->book_id === $this->id; } @@ -52,25 +45,62 @@ abstract class Entity extends Model */ public function activity() { - return $this->morphMany('BookStack\Activity', 'entity')->orderBy('created_at', 'desc'); + return $this->morphMany(Activity::class, 'entity')->orderBy('created_at', 'desc'); } /** * Get View objects for this entity. - * @return mixed */ public function views() { - return $this->morphMany('BookStack\View', 'viewable'); + return $this->morphMany(View::class, 'viewable'); } /** - * Get just the views for the current user. - * @return mixed + * 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 */ - public function userViews() + public function hasRestriction($role_id, $action) { - return $this->views()->where('user_id', '=', auth()->user()->id); + return $this->permissions()->where('role_id', '=', $role_id) + ->where('action', '=', $action)->count() > 0; + } + + /** + * Get the entity jointPermissions this is connected to. + * @return \Illuminate\Database\Eloquent\Relations\MorphMany + */ + public function jointPermissions() + { + return $this->morphMany(JointPermission::class, 'entity'); } /** @@ -81,63 +111,65 @@ abstract class Entity extends Model */ public static function isA($type) { - return static::getClassName() === strtolower($type); + return static::getType() === strtolower($type); } /** - * Gets the class name. - * @return string + * 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 getClassName() + public static function getEntityInstance($type) { - return strtolower(array_slice(explode('\\', static::class), -1, 1)[0]); + $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. + * Gets a limited-length version of the entities name. * @param int $length * @return string */ public function getShortName($length = 25) { - if(strlen($this->name) <= $length) return $this->name; - return substr($this->name, 0, $length-3) . '...'; + 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 fullTextSearch($fieldsToSearch, $terms, $wheres = []) + public function getText() { - $termString = ''; - foreach ($terms as $term) { - $termString .= $term . '* '; - } - $fields = implode(',', $fieldsToSearch); - $termStringEscaped = \DB::connection()->getPdo()->quote($termString); - $search = static::addSelect(\DB::raw('*, MATCH(name) AGAINST('.$termStringEscaped.' IN BOOLEAN MODE) AS title_relevance')); - $search = $search->whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]); - - // Add additional where terms - foreach ($wheres as $whereTerm) { - $search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]); - } - - // Load in relations - if (!static::isA('book')) $search = $search->with('book'); - if (static::isA('page')) $search = $search->with('chapter'); - - return $search->orderBy('title_relevance', 'desc')->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 */ - abstract public function getUrl(); + public function getUrl($path){return '/';} }