<?php namespace BookStack;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
class Entity extends Ownable
{
- protected $fieldsToSearch = ['name', 'description'];
+ public $textField = 'description';
/**
* Compares this entity to another given entity.
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.
*/
->where('action', '=', $action)->count() > 0;
}
- /**
- * Check if this entity has live (active) restrictions in place.
- * @param $role_id
- * @param $action
- * @return bool
- */
- public function hasActiveRestriction($role_id, $action)
- {
- return $this->getRawAttribute('restricted') && $this->hasRestriction($role_id, $action);
- }
-
/**
* Get the entity jointPermissions this is connected to.
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
}
/**
- * 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 function fullTextSearchQuery($terms, $wheres = [])
+ public function getText()
{
- $exactTerms = [];
- $fuzzyTerms = [];
- $search = static::newQuery();
-
- foreach ($terms as $key => $term) {
- $term = htmlentities($term, ENT_QUOTES);
- $term = preg_replace('/[+\-><\(\)~*\"@]+/', ' ', $term);
- if (preg_match('/".*?"/', $term) || is_numeric($term)) {
- $term = str_replace('"', '', $term);
- $exactTerms[] = '%' . $term . '%';
- } else {
- $term = '' . $term . '*';
- if ($term !== '*') $fuzzyTerms[] = $term;
- }
- }
-
- $isFuzzy = count($exactTerms) === 0 && count($fuzzyTerms) > 0;
-
-
- // Perform fulltext search if relevant terms exist.
- if ($isFuzzy) {
- $termString = implode(' ', $fuzzyTerms);
- $fields = implode(',', $this->fieldsToSearch);
- $search = $search->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) {
- foreach ($exactTerms as $exactTerm) {
- foreach ($this->fieldsToSearch as $field) {
- $query->orWhere($field, 'like', $exactTerm);
- }
- }
- });
- }
-
- $orderBy = $isFuzzy ? 'title_relevance' : 'updated_at';
-
- // Add additional where terms
- foreach ($wheres as $whereTerm) {
- $search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
- }
+ return $this->{$this->textField};
+ }
- // Load in relations
- if ($this->isA('page')) {
- $search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
- } else if ($this->isA('chapter')) {
- $search = $search->with('book');
- }
+ /**
+ * Return a generalised, common raw query that can be 'unioned' across entities.
+ * @return string
+ */
+ public function entityRawQuery(){return '';}
- return $search->orderBy($orderBy, 'desc');
- }
+ /**
+ * Get the url of this entity
+ * @param $path
+ * @return string
+ */
+ public function getUrl($path){return '/';}
}