Files
UNIT3D-Community-Edition/app/Models/Message.php
Roardom 8b27413fe8 refactor: make laravel eloquent models final
We never plan to extend a model, and value composition over inheritance. We need to add the AllowDynamicProperties warning to prevent PHPStan errors that arise with pivot relations (https://www.github.com/larastan/larastan/issues/2256).
2025-10-29 10:19:39 +00:00

95 lines
2.3 KiB
PHP

<?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 Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use AllowDynamicProperties;
/**
* App\Models\Message.
*
* @property int $id
* @property int $user_id
* @property int $chatroom_id
* @property int|null $receiver_id
* @property int|null $bot_id
* @property string $message
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
*/
#[AllowDynamicProperties]
final class Message extends Model
{
/** @use HasFactory<\Database\Factories\MessageFactory> */
use HasFactory;
/**
* The attributes that are mass assignable.
*
* @var list<string>
*/
protected $fillable = [
'message',
'user_id',
'chatroom_id',
'receiver_id',
'bot_id',
];
/**
* Get the bot that sent the message.
*
* @return BelongsTo<Bot, $this>
*/
public function bot(): BelongsTo
{
return $this->belongsTo(Bot::class);
}
/**
* Get the user that sent the message.
*
* @return BelongsTo<User, $this>
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class);
}
/**
* Get the user that received the message.
*
* @return BelongsTo<User, $this>
*/
public function receiver(): BelongsTo
{
return $this->belongsTo(User::class, 'receiver_id');
}
/**
* Get the chatroom the message was sent in.
*
* @return BelongsTo<Chatroom, $this>
*/
public function chatroom(): BelongsTo
{
return $this->belongsTo(Chatroom::class);
}
}