* @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\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\MorphTo; use AllowDynamicProperties; /** * App\Models\Comment. * * @property int $id * @property string $content * @property int $anon * @property int|null $user_id * @property int|null $parent_id * @property \Illuminate\Support\Carbon|null $created_at * @property \Illuminate\Support\Carbon|null $updated_at * @property string $commentable_type * @property int $commentable_id */ #[AllowDynamicProperties] final class Comment extends Model { use Auditable; /** @use HasFactory<\Database\Factories\CommentFactory> */ use HasFactory; /** * The attributes that aren't mass assignable. * * @var string[] */ protected $guarded = []; /** * Get the attributes that should be cast. * * @return array{anon: 'bool'} */ protected function casts(): array { return [ 'anon' => 'bool', ]; } /** * Get the user that owns the comment. * * @return BelongsTo */ public function user(): BelongsTo { return $this->belongsTo(User::class)->withDefault([ 'username' => 'System', 'id' => User::SYSTEM_USER_ID, ]); } /** * Get the parent commentable model. * * @return MorphTo */ public function commentable(): MorphTo { return $this->morphTo(); } /** * Get the children comments for this comment. * * @return HasMany */ public function children(): HasMany { return $this->hasMany(__CLASS__, 'parent_id')->oldest(); } public function isParent(): bool { return null === $this->parent_id; } public function isChild(): bool { return null !== $this->parent_id; } /** * Scope a query to only include parent comments. * * @param Builder $builder */ public function scopeParent(Builder $builder): void { $builder->whereNull('parent_id'); } }