Files
UNIT3D-Community-Edition/app/Models/Note.php
Roardom 72a1e1a885 refactor: rename warnings/bans/notes <-> user/staff relations
These relations are older than the laravel convention for using camel case. Clean up their names to match modern styling and make them easier to read.
2025-11-08 10:23:22 +00:00

83 lines
2.1 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 App\Traits\Auditable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use AllowDynamicProperties;
/**
* App\Models\Note.
*
* @property int $id
* @property int $user_id
* @property int $staff_id
* @property string $message
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
*/
#[AllowDynamicProperties]
final class Note extends Model
{
use Auditable;
/** @use HasFactory<\Database\Factories\NoteFactory> */
use HasFactory;
/**
* The table associated with the model.
*
* @var string
*/
protected $table = 'user_notes';
/**
* The attributes that aren't mass assignable.
*
* @var string[]
*/
protected $guarded = ['id', 'created_at', 'updated_at'];
/**
* Get the user that was noted.
*
* @return BelongsTo<User, $this>
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class, 'user_id')->withDefault([
'username' => 'System',
'id' => User::SYSTEM_USER_ID,
]);
}
/**
* Get the staff user wrote the note.
*
* @return BelongsTo<User, $this>
*/
public function staff(): BelongsTo
{
return $this->belongsTo(User::class, 'staff_id')->withDefault([
'username' => 'System',
'id' => User::SYSTEM_USER_ID,
]);
}
}