2016-02-27 19:24:42 +00:00
|
|
|
<?php namespace BookStack;
|
2015-08-16 13:51:45 +00:00
|
|
|
|
|
|
|
|
2016-02-27 19:24:42 +00:00
|
|
|
abstract class Entity extends Ownable
|
2015-08-16 13:51:45 +00:00
|
|
|
{
|
2015-11-21 17:22:14 +00:00
|
|
|
|
2015-08-16 13:51:45 +00:00
|
|
|
/**
|
|
|
|
* Compares this entity to another given entity.
|
|
|
|
* Matches by comparing class and id.
|
|
|
|
* @param $entity
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function matches($entity)
|
|
|
|
{
|
|
|
|
return [get_class($this), $this->id] === [get_class($entity), $entity->id];
|
|
|
|
}
|
2015-08-16 17:59:23 +00:00
|
|
|
|
2015-11-29 18:06:55 +00:00
|
|
|
/**
|
|
|
|
* 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;
|
|
|
|
|
2016-01-02 14:48:35 +00:00
|
|
|
if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
|
2015-11-29 18:06:55 +00:00
|
|
|
return $entity->book_id === $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($entity->isA('page') && $this->isA('chapter')) {
|
|
|
|
return $entity->chapter_id === $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-08-16 17:59:23 +00:00
|
|
|
/**
|
2015-11-21 17:22:14 +00:00
|
|
|
* Gets the activity objects for this entity.
|
2015-08-16 17:59:23 +00:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
|
|
|
public function activity()
|
|
|
|
{
|
2015-09-10 18:31:09 +00:00
|
|
|
return $this->morphMany('BookStack\Activity', 'entity')->orderBy('created_at', 'desc');
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|
|
|
|
|
2015-11-21 17:22:14 +00:00
|
|
|
/**
|
|
|
|
* Get View objects for this entity.
|
|
|
|
*/
|
|
|
|
public function views()
|
|
|
|
{
|
|
|
|
return $this->morphMany('BookStack\View', 'viewable');
|
|
|
|
}
|
|
|
|
|
2016-02-28 10:49:41 +00:00
|
|
|
/**
|
|
|
|
* Get this entities restrictions.
|
|
|
|
*/
|
|
|
|
public function restrictions()
|
|
|
|
{
|
|
|
|
return $this->morphMany('BookStack\Restriction', '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->restrictions->where('role_id', $role_id)->where('action', $action)->count() > 0;
|
|
|
|
}
|
|
|
|
|
2015-08-31 10:43:28 +00:00
|
|
|
/**
|
|
|
|
* Allows checking of the exact class, Used to check entity type.
|
|
|
|
* Cleaner method for is_a.
|
|
|
|
* @param $type
|
|
|
|
* @return bool
|
|
|
|
*/
|
2015-11-29 17:33:25 +00:00
|
|
|
public static function isA($type)
|
2015-08-31 10:43:28 +00:00
|
|
|
{
|
2015-12-05 14:41:51 +00:00
|
|
|
return static::getClassName() === strtolower($type);
|
2015-08-31 10:43:28 +00:00
|
|
|
}
|
|
|
|
|
2015-08-31 19:11:44 +00:00
|
|
|
/**
|
2016-02-27 19:24:42 +00:00
|
|
|
* Gets a limited-length version of the entities name.
|
2015-12-05 14:41:51 +00:00
|
|
|
* @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) . '...';
|
|
|
|
}
|
|
|
|
|
2015-08-31 19:11:44 +00:00
|
|
|
/**
|
|
|
|
* Perform a full-text search on this entity.
|
|
|
|
* @param string[] $fieldsToSearch
|
|
|
|
* @param string[] $terms
|
2015-09-01 14:35:11 +00:00
|
|
|
* @param string[] array $wheres
|
2015-08-31 19:11:44 +00:00
|
|
|
* @return mixed
|
|
|
|
*/
|
2016-02-21 12:53:58 +00:00
|
|
|
public static function fullTextSearchQuery($fieldsToSearch, $terms, $wheres = [])
|
2015-08-31 19:11:44 +00:00
|
|
|
{
|
|
|
|
$termString = '';
|
2015-09-01 14:35:11 +00:00
|
|
|
foreach ($terms as $term) {
|
2015-12-29 15:37:13 +00:00
|
|
|
$termString .= htmlentities($term) . '* ';
|
2015-08-31 19:11:44 +00:00
|
|
|
}
|
|
|
|
$fields = implode(',', $fieldsToSearch);
|
2015-12-05 15:11:48 +00:00
|
|
|
$termStringEscaped = \DB::connection()->getPdo()->quote($termString);
|
|
|
|
$search = static::addSelect(\DB::raw('*, MATCH(name) AGAINST('.$termStringEscaped.' IN BOOLEAN MODE) AS title_relevance'));
|
2016-02-21 12:53:58 +00:00
|
|
|
$search = $search->whereRaw('MATCH(' . $fields . ') AGAINST(? IN BOOLEAN MODE)', [$termString]);
|
2015-12-05 15:11:48 +00:00
|
|
|
|
|
|
|
// Add additional where terms
|
2015-09-01 14:35:11 +00:00
|
|
|
foreach ($wheres as $whereTerm) {
|
|
|
|
$search->where($whereTerm[0], $whereTerm[1], $whereTerm[2]);
|
|
|
|
}
|
2015-11-29 17:33:25 +00:00
|
|
|
|
2015-12-05 15:11:48 +00:00
|
|
|
// Load in relations
|
2016-02-21 12:53:58 +00:00
|
|
|
if (static::isA('page')) {
|
|
|
|
$search = $search->with('book', 'chapter', 'createdBy', 'updatedBy');
|
|
|
|
} else if (static::isA('chapter')) {
|
|
|
|
$search = $search->with('book');
|
|
|
|
}
|
2015-11-29 17:33:25 +00:00
|
|
|
|
2016-02-21 12:53:58 +00:00
|
|
|
return $search->orderBy('title_relevance', 'desc');
|
2015-08-31 19:11:44 +00:00
|
|
|
}
|
|
|
|
|
2015-09-04 16:50:52 +00:00
|
|
|
/**
|
|
|
|
* Get the url for this item.
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
abstract public function getUrl();
|
|
|
|
|
2015-08-16 13:51:45 +00:00
|
|
|
}
|