X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/62338e4a8fc3401dad8b01adf165f34a63ebe907..refs/pull/448/head:/app/Entity.php diff --git a/app/Entity.php b/app/Entity.php index 68c773592..e5dd04bf2 100644 --- a/app/Entity.php +++ b/app/Entity.php @@ -1,29 +1,10 @@ -belongsTo('BookStack\User', 'created_by'); - } - - /** - * Relation for the user that updated this entity. - * @return \Illuminate\Database\Eloquent\Relations\BelongsTo - */ - public function updatedBy() - { - return $this->belongsTo('BookStack\User', 'updated_by'); - } + public $textField = 'description'; /** * Compares this entity to another given entity. @@ -36,31 +17,90 @@ abstract class Entity extends Model 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 + */ + public function matchesOrContains(Entity $entity) + { + $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; + } + /** * Gets the activity objects for this entity. * @return \Illuminate\Database\Eloquent\Relations\MorphMany */ 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 userViews() + public function tags() { - return $this->views()->where('user_id', '=', auth()->user()->id); + 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 hasRestriction($role_id, $action) + { + 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'); } /** @@ -71,52 +111,65 @@ abstract class Entity extends Model */ public static function isA($type) { - return static::getName() === strtolower($type); + return static::getType() === strtolower($type); } /** - * Gets the class name. - * @return string + * Get entity type. + * @return mixed */ - public static function getName() + public static function getType() { - return strtolower(array_slice(explode('\\', static::class), -1, 1)[0]); + return strtolower(static::getClassName()); } /** - * Perform a full-text search on this entity. - * @param string[] $fieldsToSearch - * @param string[] $terms - * @param string[] array $wheres - * @return mixed + * Get an instance of an entity of the given type. + * @param $type + * @return Entity */ - public static function fullTextSearch($fieldsToSearch, $terms, $wheres = []) + public static function getEntityInstance($type) { - $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]); + $types = ['Page', 'Book', 'Chapter']; + $className = str_replace([' ', '-', '_'], '', ucwords($type)); + if (!in_array($className, $types)) { + return null; } - if (!static::isA('book')) { - $search = $search->with('book'); - } + return app('BookStack\\' . $className); + } - if(static::isA('page')) { - $search = $search->with('chapter'); - } + /** + * 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) . '...'; + } - return $search->get(); + /** + * Get the body text of this entity. + * @return mixed + */ + 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 + */ + public function entityRawQuery(){return '';} + + /** + * Get the url of this entity + * @param $path * @return string */ - abstract public function getUrl(); + public function getUrl($path){return '/';} }