solidtime/app/Models/TimeEntry.php

<?php

declare(strict_types=1);

namespace App\Models;

use App\Models\Concerns\CustomAuditable;
use App\Models\Concerns\HasUuids;
use App\Service\BillableRateService;
use Carbon\CarbonInterval;
use Database\Factories\TimeEntryFactory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Carbon;
use Korridor\LaravelComputedAttributes\ComputedAttributes;
use OwenIt\Auditing\Contracts\Auditable as AuditableContract;
use Staudenmeir\EloquentJsonRelations\HasJsonRelationships;
use Staudenmeir\EloquentJsonRelations\Relations\BelongsToJson;

/**
 * @property string $id
 * @property string $description
 * @property Carbon $start
 * @property Carbon|null $end
 * @property int|null $billable_rate Billable rate per hour in cents
 * @property bool $billable
 * @property array<string> $tags
 * @property string $user_id
 * @property string $member_id
 * @property bool $is_imported
 * @property Carbon|null $still_active_email_sent_at
 * @property Carbon|null $created_at
 * @property Carbon|null $updated_at
 * @property-read User $user
 * @property-read Member $member
 * @property string $organization_id
 * @property-read Organization $organization
 * @property string|null $project_id
 * @property-read Project|null $project
 * @property string|null $client_id
 * @property-read Client|null $client
 * @property string|null $task_id
 * @property-read Task|null $task
 * @property-read Collection<int, Tag> $tagsRelation
 *
 * @method Builder<TimeEntry> hasTag(Tag $tag)
 * @method static TimeEntryFactory factory()
 */
class TimeEntry extends Model implements AuditableContract
{
    use ComputedAttributes;
    use CustomAuditable;

    /** @use HasFactory<TimeEntryFactory> */
    use HasFactory;

    use HasJsonRelationships;
    use HasUuids;

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'description' => 'string',
        'start' => 'datetime',
        'end' => 'datetime',
        'billable' => 'bool',
        'tags' => 'array',
        'billable_rate' => 'int',
        'is_imported' => 'bool',
        'still_active_email_sent_at' => 'datetime',
    ];

    public const array SELECT_COLUMNS = [
        'id',
        'description',
        'start',
        'end',
        'billable_rate',
        'billable',
        'user_id',
        'organization_id',
        'project_id',
        'task_id',
        'tags',
        'created_at',
        'updated_at',
        'member_id',
        'client_id',
        'is_imported',
        'still_active_email_sent_at',
    ];

    /**
     * The attributes that are computed. (f.e. for performance reasons)
     * These attributes can be regenerated at any time.
     *
     * @var string[]
     */
    protected array $computed = [
        'billable_rate',
        'client_id',
    ];

    /**
     * Attributes to exclude from the Audit.
     *
     * @var array<string>
     */
    protected array $auditExclude = [
        'billable_rate',
    ];

    public function getBillableRateComputed(): ?int
    {
        return app(BillableRateService::class)->getBillableRateForTimeEntry($this);
    }

    public function getClientIdComputed(): ?string
    {
        return $this->project_id === null || $this->project === null ? null : $this->project->client_id;
    }

    /**
     * This scope will be applied during the computed property generation with artisan computed-attributes:generate.
     *
     * @param  Builder<TimeEntry>  $builder
     * @param  array<string>  $attributes  Attributes that will be generated.
     * @return Builder<TimeEntry>
     */
    public function scopeComputedAttributesGenerate(Builder $builder, array $attributes): Builder
    {
        if (in_array('client_id', $attributes, true)) {
            $builder->with([
                'project' => function (Relation $builder): void {
                    /** @var Builder<Project> $builder */
                    $builder->select('id', 'client_id');
                },
            ]);
        }

        return $builder;
    }

    /**
     * This scope will be applied during the computed property validation with artisan computed-attributes:validate.
     *
     * @param  Builder<TimeEntry>  $builder
     * @param  array<string>  $attributes  Attributes that will be validated.
     * @return Builder<TimeEntry>
     */
    public function scopeComputedAttributesValidate(Builder $builder, array $attributes): Builder
    {
        return $this->scopeComputedAttributesGenerate($builder, $attributes);
    }

    public function getDuration(): ?CarbonInterval
    {
        return $this->end === null ? null : $this->start->diffAsCarbonInterval($this->end);
    }

    /**
     * @param  Builder<TimeEntry>  $builder
     */
    public function scopeHasTag(Builder $builder, Tag $tag): void
    {
        $builder->whereJsonContains('tags', $tag->getKey());
    }

    /**
     * @return BelongsTo<User, $this>
     */
    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class, 'user_id');
    }

    /**
     * @return BelongsTo<Member, $this>
     */
    public function member(): BelongsTo
    {
        return $this->belongsTo(Member::class, 'member_id');
    }

    /**
     * @return BelongsTo<Organization, $this>
     */
    public function organization(): BelongsTo
    {
        return $this->belongsTo(Organization::class, 'organization_id');
    }

    /**
     * @return BelongsTo<Project, $this>
     */
    public function project(): BelongsTo
    {
        return $this->belongsTo(Project::class, 'project_id');
    }

    /**
     * @return BelongsTo<Task, $this>
     */
    public function task(): BelongsTo
    {
        return $this->belongsTo(Task::class, 'task_id');
    }

    /**
     * This relation can be reconstructed via the task relation. It is only here for performance reasons.
     *
     * @return BelongsTo<Client, $this>
     */
    public function client(): BelongsTo
    {
        return $this->belongsTo(Client::class, 'client_id');
    }

    /**
     * Warning: This relation based on a JSON column. Please make sure that there are no performance issues, before using it.
     *
     * @return BelongsToJson<Tag, $this>
     */
    public function tagsRelation(): BelongsToJson
    {
        return $this->belongsToJson(Tag::class, 'tags');
    }
}