<?php

namespace Modules\Platform\User\Entities;

use Illuminate\Database\Eloquent\Model;

/**
 * Class UserExtension
 *
 * Represents a SIP/PJSIP/WSS extension that belongs to a User.
 * A single user may own multiple extensions with different protocols.
 *
 * @package Modules\Platform\User\Entities
 *
 * @property int         $id
 * @property int         $user_id
 * @property string|null $label
 * @property string|null $sip_domain
 * @property string|null $sip_port
 * @property string      $sip_protocol         'sip' | 'pjsip' | 'wss'
 * @property bool        $sip_credentials_enabled
 * @property \Illuminate\Support\Carbon|null $created_at
 * @property \Illuminate\Support\Carbon|null $updated_at
 *
 * @property-read \Modules\Platform\User\Entities\User $user
 */
class UserExtension extends Model
{
    /** Allowed SIP protocols */
    const PROTOCOL_SIP   = 'sip';
    const PROTOCOL_PJSIP = 'pjsip';
    const PROTOCOL_WSS   = 'wss';

    const PROTOCOLS = [
        self::PROTOCOL_SIP   => 'SIP',
        self::PROTOCOL_PJSIP => 'PJSIP',
        self::PROTOCOL_WSS   => 'WSS (WebRTC)',
    ];

    protected $table = 'user_extensions';

    protected $fillable = [
        'user_id',
        'label',
        'sip_domain',
        'sip_port',
        'sip_protocol',
        'sip_credentials_enabled',
    ];

    protected $casts = [
        'sip_credentials_enabled' => 'boolean',
    ];

    // -------------------------------------------------------------------------
    // Relationships
    // -------------------------------------------------------------------------

    /**
     * The user this extension belongs to.
     */
    public function user()
    {
        return $this->belongsTo(User::class);
    }
}