2016-02-27 20:24:42 +01:00
|
|
|
<?php namespace BookStack;
|
2015-08-16 15:51:45 +02:00
|
|
|
|
|
|
|
|
2016-05-07 15:29:43 +02:00
|
|
|
class Entity extends Ownable
|
2015-08-16 15:51:45 +02:00
|
|
|
{
|
2015-11-21 18:22:14 +01:00
|
|
|
|
2017-03-27 12:57:33 +02:00
|
|
|
public $textField = 'description';
|
2017-01-01 17:57:47 +01:00
|
|
|
|
2015-08-16 15:51:45 +02: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 19:59:23 +02:00
|
|
|
|
2015-11-29 19:06:55 +01: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 15:48:35 +01:00
|
|
|
if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
|
2015-11-29 19:06:55 +01: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 19:59:23 +02:00
|
|
|
/**
|
2015-11-21 18:22:14 +01:00
|
|
|
* Gets the activity objects for this entity.
|
2015-08-16 19:59:23 +02:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
|
|
|
public function activity()
|
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->morphMany(Activity::class, 'entity')->orderBy('created_at', 'desc');
|
2015-08-16 19:59:23 +02:00
|
|
|
}
|
|
|
|
|
2015-11-21 18:22:14 +01:00
|
|
|
/**
|
|
|
|
* Get View objects for this entity.
|
|
|
|
*/
|
|
|
|
public function views()
|
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->morphMany(View::class, 'viewable');
|
2015-11-21 18:22:14 +01:00
|
|
|
}
|
|
|
|
|
2016-05-06 21:33:08 +02:00
|
|
|
/**
|
2016-05-13 22:20:21 +02:00
|
|
|
* Get the Tag models that have been user assigned to this entity.
|
2016-05-06 21:33:08 +02:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
2016-05-13 22:20:21 +02:00
|
|
|
public function tags()
|
2016-05-06 21:33:08 +02:00
|
|
|
{
|
2016-05-14 21:02:00 +02:00
|
|
|
return $this->morphMany(Tag::class, 'entity')->orderBy('order', 'asc');
|
2016-05-06 21:33:08 +02:00
|
|
|
}
|
|
|
|
|
2017-03-19 13:48:44 +01:00
|
|
|
/**
|
|
|
|
* Get the related search terms.
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
|
|
|
public function searchTerms()
|
|
|
|
{
|
|
|
|
return $this->morphMany(SearchTerm::class, 'entity');
|
|
|
|
}
|
|
|
|
|
2015-08-31 12:43:28 +02:00
|
|
|
/**
|
2016-02-28 11:49:41 +01:00
|
|
|
* Get this entities restrictions.
|
|
|
|
*/
|
2016-05-01 22:20:50 +02:00
|
|
|
public function permissions()
|
2016-02-28 11:49:41 +01:00
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->morphMany(EntityPermission::class, 'restrictable');
|
2016-02-28 11:49:41 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if this entity has a specific restriction set against it.
|
|
|
|
* @param $role_id
|
|
|
|
* @param $action
|
2015-08-31 12:43:28 +02:00
|
|
|
* @return bool
|
|
|
|
*/
|
2016-02-28 11:49:41 +01:00
|
|
|
public function hasRestriction($role_id, $action)
|
2015-08-31 12:43:28 +02:00
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->permissions()->where('role_id', '=', $role_id)
|
2016-04-24 17:54:20 +02:00
|
|
|
->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)
|
|
|
|
{
|
2016-04-30 18:16:06 +02:00
|
|
|
return $this->getRawAttribute('restricted') && $this->hasRestriction($role_id, $action);
|
2015-08-31 12:43:28 +02:00
|
|
|
}
|
|
|
|
|
2016-04-23 19:14:26 +02:00
|
|
|
/**
|
2016-05-01 22:20:50 +02:00
|
|
|
* Get the entity jointPermissions this is connected to.
|
2016-04-23 19:14:26 +02:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
|
|
*/
|
2016-05-01 22:20:50 +02:00
|
|
|
public function jointPermissions()
|
2016-04-23 19:14:26 +02:00
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->morphMany(JointPermission::class, 'entity');
|
2016-04-23 19:14:26 +02:00
|
|
|
}
|
|
|
|
|
2015-08-31 21:11:44 +02:00
|
|
|
/**
|
2015-08-31 12:43:28 +02:00
|
|
|
* Allows checking of the exact class, Used to check entity type.
|
|
|
|
* Cleaner method for is_a.
|
|
|
|
* @param $type
|
|
|
|
* @return bool
|
2015-08-31 21:11:44 +02:00
|
|
|
*/
|
2015-11-29 18:33:25 +01:00
|
|
|
public static function isA($type)
|
2015-08-31 12:43:28 +02:00
|
|
|
{
|
2016-04-23 19:14:26 +02:00
|
|
|
return static::getType() === strtolower($type);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get entity type.
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public static function getType()
|
|
|
|
{
|
|
|
|
return strtolower(static::getClassName());
|
2015-08-31 12:43:28 +02:00
|
|
|
}
|
|
|
|
|
2016-05-06 21:33:08 +02:00
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
}
|
|
|
|
|
2015-12-05 15:41:51 +01:00
|
|
|
/**
|
2016-02-27 20:24:42 +01:00
|
|
|
* Gets a limited-length version of the entities name.
|
2015-12-05 15:41:51 +01:00
|
|
|
* @param int $length
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getShortName($length = 25)
|
|
|
|
{
|
2016-03-04 21:49:35 +01:00
|
|
|
if (strlen($this->name) <= $length) return $this->name;
|
|
|
|
return substr($this->name, 0, $length - 3) . '...';
|
2015-12-05 15:41:51 +01:00
|
|
|
}
|
|
|
|
|
2017-03-19 13:48:44 +01:00
|
|
|
/**
|
|
|
|
* Get the body text of this entity.
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function getText()
|
|
|
|
{
|
|
|
|
return $this->{$this->textField};
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return a generalised, common raw query that can be 'unioned' across entities.
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function entityRawQuery(){return '';}
|
|
|
|
|
2016-08-25 18:17:26 +02:00
|
|
|
|
2015-08-16 15:51:45 +02:00
|
|
|
}
|