mirror/UNIT3D-Community-Edition
1
0
Fork 0
mirror of https://github.com/HDInnovations/UNIT3D-Community-Edition.git synced 2026-04-22 18:20:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

update: model phpdocs

Browse Source 
- `use` the relation types
- Use sentence case
- Write better summaries similar to laravel's documentation (don't just repeat the type and the model)
This commit is contained in:
Roardom
2025-09-13 04:38:03 +00:00
parent b11d41269b
commit 3988eaaf70
108 changed files with 1509 additions and 1190 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/Models/Invite.php
+7 -6
View File
@@ -19,6 +19,7 @@ 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 Illuminate\Database\Eloquent\SoftDeletes;
/**
@@ -48,11 +49,11 @@ class Invite extends Model
protected $guarded = [];
/**
* Belongs To A User.
* The user that sent the invite.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<User, $this>
* @return BelongsTo<User, $this>
*/
public function sender(): \Illuminate\Database\Eloquent\Relations\BelongsTo
public function sender(): BelongsTo
{
return $this->belongsTo(User::class, 'user_id')->withDefault([
'username' => 'System',
@@ -61,11 +62,11 @@ class Invite extends Model
}
/**
* Belongs To A User.
* The user that received the invite.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<User, $this>
* @return BelongsTo<User, $this>
*/
public function receiver(): \Illuminate\Database\Eloquent\Relations\BelongsTo
public function receiver(): BelongsTo
{
return $this->belongsTo(User::class, 'accepted_by')->withDefault([
'username' => 'System',