2015-08-16 13:59:23 -04:00
|
|
|
<?php
|
|
|
|
|
2018-09-25 07:30:50 -04:00
|
|
|
namespace BookStack\Actions;
|
|
|
|
|
|
|
|
use BookStack\Auth\User;
|
2020-11-21 19:17:45 -05:00
|
|
|
use BookStack\Entities\Models\Entity;
|
2018-09-25 07:30:50 -04:00
|
|
|
use BookStack\Model;
|
2020-11-07 19:03:19 -05:00
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
2021-03-07 17:24:05 -05:00
|
|
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
2020-11-20 14:33:11 -05:00
|
|
|
use Illuminate\Support\Str;
|
2015-08-16 13:59:23 -04:00
|
|
|
|
|
|
|
/**
|
2020-11-07 19:03:19 -05:00
|
|
|
* @property string $type
|
2019-09-19 13:03:17 -04:00
|
|
|
* @property User $user
|
|
|
|
* @property Entity $entity
|
2020-11-07 19:03:19 -05:00
|
|
|
* @property string $detail
|
2019-09-19 13:03:17 -04:00
|
|
|
* @property string $entity_type
|
|
|
|
* @property int $entity_id
|
|
|
|
* @property int $user_id
|
2015-08-16 13:59:23 -04:00
|
|
|
*/
|
|
|
|
class Activity extends Model
|
|
|
|
{
|
2015-08-30 06:47:58 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the entity for this activity.
|
|
|
|
*/
|
2021-03-07 17:24:05 -05:00
|
|
|
public function entity(): MorphTo
|
2015-08-16 13:59:23 -04:00
|
|
|
{
|
2018-01-28 11:58:52 -05:00
|
|
|
if ($this->entity_type === '') {
|
|
|
|
$this->entity_type = null;
|
|
|
|
}
|
2016-02-28 14:03:04 -05:00
|
|
|
return $this->morphTo('entity');
|
2015-08-16 13:59:23 -04:00
|
|
|
}
|
|
|
|
|
2015-08-30 06:47:58 -04:00
|
|
|
/**
|
|
|
|
* Get the user this activity relates to.
|
|
|
|
*/
|
2020-11-07 19:03:19 -05:00
|
|
|
public function user(): BelongsTo
|
2015-08-16 13:59:23 -04:00
|
|
|
{
|
2016-05-01 16:20:50 -04:00
|
|
|
return $this->belongsTo(User::class);
|
2015-08-16 13:59:23 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-11-07 19:03:19 -05:00
|
|
|
* Returns text from the language files, Looks up by using the activity key.
|
2015-08-16 13:59:23 -04:00
|
|
|
*/
|
2020-11-07 19:03:19 -05:00
|
|
|
public function getText(): string
|
2015-08-16 13:59:23 -04:00
|
|
|
{
|
2020-11-07 19:03:19 -05:00
|
|
|
return trans('activities.' . $this->type);
|
2015-08-16 13:59:23 -04:00
|
|
|
}
|
|
|
|
|
2020-11-20 14:33:11 -05:00
|
|
|
/**
|
|
|
|
* Check if this activity is intended to be for an entity.
|
|
|
|
*/
|
|
|
|
public function isForEntity(): bool
|
|
|
|
{
|
|
|
|
return Str::startsWith($this->type, [
|
|
|
|
'page_', 'chapter_', 'book_', 'bookshelf_'
|
|
|
|
]);
|
|
|
|
}
|
|
|
|
|
2015-08-30 06:47:58 -04:00
|
|
|
/**
|
|
|
|
* Checks if another Activity matches the general information of another.
|
|
|
|
*/
|
2020-04-10 15:55:33 -04:00
|
|
|
public function isSimilarTo(Activity $activityB): bool
|
2018-01-28 11:58:52 -05:00
|
|
|
{
|
2020-11-07 19:03:19 -05:00
|
|
|
return [$this->type, $this->entity_type, $this->entity_id] === [$activityB->type, $activityB->entity_type, $activityB->entity_id];
|
2015-08-30 06:47:58 -04:00
|
|
|
}
|
2015-08-16 13:59:23 -04:00
|
|
|
}
|