Files
UNIT3D-Community-Edition/app/Models/Article.php
Roardom 3988eaaf70 update: model phpdocs
- `use` the relation types
- Use sentence case
- Write better summaries similar to laravel's documentation (don't just repeat the type and the model)
2025-09-20 01:35:37 +00:00

84 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 Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;
/**
* App\Models\Article.
*
* @property int $id
* @property string $title
* @property string|null $image
* @property string $content
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property int $user_id
*/
class Article extends Model
{
use Auditable;
/** @use HasFactory<\Database\Factories\ArticleFactory> */
use HasFactory;
/**
* The attributes that aren't mass assignable.
*
* @var string[]
*/
protected $guarded = ['id', 'created_at', 'updated_at'];
/**
* Get the author of the article.
*
* @return BelongsTo<User, $this>
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class)->withDefault([
'username' => 'System',
'id' => User::SYSTEM_USER_ID,
]);
}
/**
* Get the comments for the article.
*
* @return MorphMany<Comment, $this>
*/
public function comments(): MorphMany
{
return $this->morphMany(Comment::class, 'commentable');
}
/**
* Get the unreads for the article.
*
* @return HasMany<UnreadArticle, $this>
*/
public function unreads(): HasMany
{
return $this->HasMany(UnreadArticle::class);
}
}