Files
mytodos/app/Models/Todo.php
T
ecdown 1e8ae3d1e5
tests / ci (push) Canceled after 0s
first commit;
2026-09-17 23:01:26 -07:00

111 lines
2.8 KiB
PHP

<?php
namespace App\Models;
use Database\Factories\TodoFactory;
use Illuminate\Database\Eloquent\Attributes\Fillable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Support\Carbon;
/**
* @property int $id
* @property int $user_id
* @property int $folder_id
* @property string $description
* @property string|null $notes
* @property Carbon|null $due_date
* @property Carbon|null $completed_at
* @property Folder $folder
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
*/
#[Fillable(['user_id', 'folder_id', 'description', 'notes', 'due_date', 'completed_at'])]
class Todo extends Model
{
/** @use HasFactory<TodoFactory> */
use HasFactory;
/** @return BelongsTo<User, $this> */
public function user(): BelongsTo
{
return $this->belongsTo(User::class);
}
/** @return BelongsTo<Folder, $this> */
public function folder(): BelongsTo
{
return $this->belongsTo(Folder::class);
}
/**
* Get the attributes that should be cast.
*
* @return array<string, string>
*/
protected function casts(): array
{
return [
'due_date' => 'date',
'completed_at' => 'datetime',
];
}
/**
* Scope the query to todos owned by the given user.
*
* @param Builder<Todo> $query
* @return Builder<Todo>
*/
public function scopeForUser(Builder $query, User|int $user): Builder
{
return $query->where('user_id', $user instanceof User ? $user->id : $user);
}
/**
* Scope the query to todos that have not been completed.
*
* @param Builder<Todo> $query
* @return Builder<Todo>
*/
public function scopeIncomplete(Builder $query): Builder
{
return $query->whereNull('completed_at');
}
/**
* Scope the query to todos that have been completed.
*
* @param Builder<Todo> $query
* @return Builder<Todo>
*/
public function scopeCompleted(Builder $query): Builder
{
return $query->whereNotNull('completed_at');
}
/**
* Scope the query to open todos whose due date has already passed.
*
* @param Builder<Todo> $query
* @return Builder<Todo>
*/
public function scopeOverdue(Builder $query): Builder
{
return $query->incomplete()->whereDate('due_date', '<', now());
}
/**
* Scope the query to open todos due today.
*
* @param Builder<Todo> $query
* @return Builder<Todo>
*/
public function scopeDueToday(Builder $query): Builder
{
return $query->incomplete()->whereDate('due_date', today());
}
}