-<?php
+<?php namespace BookStack;
-namespace BookStack;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
-use Illuminate\Database\Eloquent\Model;
-
-abstract class Entity extends Model
+class Entity extends Ownable
{
- use Ownable;
+ public $textField = 'description';
/**
* Compares this entity to another given entity.
{
$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;
*/
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 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 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');
}
/**
*/
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 getClassName()
+ public static function getType()
{
- return strtolower(array_slice(explode('\\', static::class), -1, 1)[0]);
+ return strtolower(static::getClassName());
}
/**
- *Gets a limited-length version of the entities name.
+ * 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
*/
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 fullTextSearchQuery($fieldsToSearch, $terms, $wheres = [])
+ public function getText()
{
- foreach ($terms as $key => $term) {
- $term = htmlentities($term);
- if (preg_match('/\s/', $term)) {
- $term = '"' . $term . '"';
- }
- $terms[$key] = $term . '*';
- }
- $termString = "'" . implode(' ', $terms) . "'";
- $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('page')) {
- $search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
- } else if (static::isA('chapter')) {
- $search = $search->with('book');
- }
-
- return $search->orderBy('title_relevance', 'desc');
+ 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 '/';
+ }
}
projects / bookstack / blobdiff