3 namespace BookStack\Activity\Models;
5 use BookStack\App\Model;
6 use BookStack\Entities\Models\Entity;
7 use BookStack\Permissions\Models\JointPermission;
8 use BookStack\Users\Models\User;
9 use Illuminate\Database\Eloquent\Relations\BelongsTo;
10 use Illuminate\Database\Eloquent\Relations\HasMany;
11 use Illuminate\Database\Eloquent\Relations\MorphTo;
12 use Illuminate\Support\Carbon;
13 use Illuminate\Support\Str;
16 * @property string $type
17 * @property User $user
18 * @property Entity $entity
19 * @property string $detail
20 * @property string $entity_type
21 * @property int $entity_id
22 * @property int $user_id
23 * @property Carbon $created_at
24 * @property Carbon $updated_at
26 class Activity extends Model
29 * Get the entity for this activity.
31 public function entity(): MorphTo
33 if ($this->entity_type === '') {
34 $this->entity_type = null;
37 return $this->morphTo('entity');
41 * Get the user this activity relates to.
43 public function user(): BelongsTo
45 return $this->belongsTo(User::class);
48 public function jointPermissions(): HasMany
50 return $this->hasMany(JointPermission::class, 'entity_id', 'entity_id')
51 ->whereColumn('activities.entity_type', '=', 'joint_permissions.entity_type');
55 * Returns text from the language files, Looks up by using the activity key.
57 public function getText(): string
59 return trans('activities.' . $this->type);
63 * Check if this activity is intended to be for an entity.
65 public function isForEntity(): bool
67 return Str::startsWith($this->type, [
68 'page_', 'chapter_', 'book_', 'bookshelf_',
73 * Checks if another Activity matches the general information of another.
75 public function isSimilarTo(self $activityB): bool
77 return [$this->type, $this->entity_type, $this->entity_id] === [$activityB->type, $activityB->entity_type, $activityB->entity_id];