firefly-iii/app/Models/InvitedUser.php

<?php

/*
 * InvitedUser.php
 * Copyright (c) 2022 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Models;

use Eloquent;
use FireflyIII\User;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Carbon\Carbon;

/**
 * Class InvitedUser
 *
 * @property-read User $user
 * @method static Builder|InvitedUser newModelQuery()
 * @method static Builder|InvitedUser newQuery()
 * @method static Builder|InvitedUser query()
 * @mixin Eloquent
 * @property int $id
 * @property Carbon|null $created_at
 * @property Carbon|null $updated_at
 * @property int $user_id
 * @property string $email
 * @property string $invite_code
 * @property Carbon $expires
 * @property bool $redeemed
 * @method static Builder|InvitedUser whereCreatedAt($value)
 * @method static Builder|InvitedUser whereEmail($value)
 * @method static Builder|InvitedUser whereExpires($value)
 * @method static Builder|InvitedUser whereId($value)
 * @method static Builder|InvitedUser whereInviteCode($value)
 * @method static Builder|InvitedUser whereRedeemed($value)
 * @method static Builder|InvitedUser whereUpdatedAt($value)
 * @method static Builder|InvitedUser whereUserId($value)
 */
class InvitedUser extends Model
{
    protected $casts
        = [
            'expires'  => 'datetime',
            'redeemed' => 'boolean',
        ];
    protected $fillable = ['user_id', 'email', 'invite_code', 'expires', 'redeemed'];

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