<?php

declare(strict_types=1);

/**
 * NOTICE OF LICENSE.
 *
 * UNIT3D Community Edition is open-sourced software licensed under the GNU Affero General Public License v3.0
 * The details is bundled with this project in the file LICENSE.txt.
 *
 * @project    UNIT3D Community Edition
 *
 * @author     HDVinnie <hdinnovations@protonmail.com>
 * @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\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\Pivot;
use AllowDynamicProperties;

/**
 * App\Models\InternalUser.
 *
 * @property int $id
 * @property int $user_id
 * @property int $internal_id
 */
#[AllowDynamicProperties]
final class InternalUser extends Pivot
{
    use Auditable;

    /**
     * Indicates if the IDs are auto-incrementing.
     *
     * @var bool
     */
    public $incrementing = true;

    /**
     * The user that is a member of the internal group.
     *
     * @return BelongsTo<User, $this>
     */
    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }

    /**
     * The internal group the user is a member of.
     *
     * @return BelongsTo<Internal, $this>
     */
    public function internal(): BelongsTo
    {
        return $this->belongsTo(Internal::class);
    }
}