* @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 Illuminate\Database\Eloquent\SoftDeletes; use AllowDynamicProperties; /** * App\Models\Warning. * * @property int $id * @property int $user_id * @property int $warned_by * @property int|null $torrent * @property string $reason * @property \Illuminate\Support\Carbon|null $expires_on * @property bool $active * @property int|null $deleted_by * @property \Illuminate\Support\Carbon|null $deleted_at * @property \Illuminate\Support\Carbon|null $created_at * @property \Illuminate\Support\Carbon|null $updated_at */ #[AllowDynamicProperties] final class Warning extends Model { use Auditable; /** @use HasFactory<\Database\Factories\WarningFactory> */ use HasFactory; use SoftDeletes; protected $guarded = []; /** * Get the attributes that should be cast. * * @return array{expires_on: 'datetime', active: 'bool'} */ protected function casts(): array { return [ 'expires_on' => 'datetime', 'active' => 'bool', ]; } /** * Get the torrent associated with the warning. * * @return BelongsTo */ public function torrent(): BelongsTo { return $this->belongsTo(Torrent::class); } /** * Get the warned user. * * @return BelongsTo */ public function user(): BelongsTo { return $this->belongsTo(User::class, 'user_id')->withDefault([ 'username' => 'System', 'id' => User::SYSTEM_USER_ID, ]); } /** * Get the staff user that issued the warning. * * @return BelongsTo */ public function staff(): BelongsTo { return $this->belongsTo(User::class, 'warned_by')->withDefault([ 'username' => 'System', 'id' => User::SYSTEM_USER_ID, ]); } /** * Get the staff user that revoked the warning. * * @return BelongsTo */ public function deletedBy(): BelongsTo { return $this->belongsTo(User::class, 'deleted_by')->withDefault([ 'username' => 'System', 'id' => User::SYSTEM_USER_ID, ]); } /** * Scope query to only include active warnings. * * @param Builder $query */ public function scopeActive(Builder $query): void { $query->where('active', '=', 1); } }