* @license https://www.gnu.org/licenses/agpl-3.0.en.html/ GNU Affero General Public License v3.0 */ namespace App\Models; use App\Traits\Auditable; use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; use AllowDynamicProperties; /** * App\Models\Subscription. * * @property int $id * @property int $user_id * @property int|null $forum_id * @property int|null $topic_id * @property \Illuminate\Support\Carbon|null $created_at * @property \Illuminate\Support\Carbon|null $updated_at */ #[AllowDynamicProperties] final class Subscription extends Model { use Auditable; /** @use HasFactory<\Database\Factories\SubscriptionFactory> */ use HasFactory; /** * Get the user that owns the subscription. * * @return BelongsTo */ public function user(): BelongsTo { return $this->belongsTo(User::class)->withDefault([ 'username' => 'System', 'id' => User::SYSTEM_USER_ID, ]); } /** * Gets the subscribed topic. * * @return BelongsTo */ public function topic(): BelongsTo { return $this->belongsTo(Topic::class); } /** * Gets the subscribed forum. * * @return BelongsTo */ public function forum(): BelongsTo { return $this->belongsTo(Forum::class); } /** * Scope query to only include subscriptions of a forum. * * @param Builder $query * @return Builder */ public function scopeOfForum(Builder $query, int $forum_id): Builder { return $query->where('forum_id', '=', $forum_id); } /** * Scope query to only include subscriptions of a topic. * * @param Builder $query * @return Builder */ public function scopeOfTopic($query, int $topic_id): Builder { return $query->where('topic_id', '=', $topic_id); } }