Files
UNIT3D-Community-Edition/app/Models/BonTransactions.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

116 lines
2.7 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\BonTransactions.
*
* @property int $id
* @property int $bon_exchange_id
* @property string $name
* @property string $cost
* @property int|null $sender_id
* @property int|null $receiver_id
* @property int|null $torrent_id
* @property int|null $post_id
* @property string $comment
* @property string $created_at
*/
#[AllowDynamicProperties]
final class BonTransactions extends Model
{
/** @use HasFactory<\Database\Factories\BonTransactionsFactory> */
use HasFactory;
/**
* Indicates if the model should be timestamped.
*
* @var bool
*/
public $timestamps = false;
/**
* The storage format of the model's date columns.
*
* @var string
*/
protected $dateFormat = 'U';
/**
* The attributes that aren't mass assignable.
*
* @var string[]
*/
protected $guarded = ['id', 'created_at', 'updated_at'];
/**
* Get the attributes that should be cast.
*
* @return array{cost: 'decimal:2'}
*/
protected function casts(): array
{
return [
'cost' => 'decimal:2',
];
}
/**
* Get the user that sent the bon.
*
* @return BelongsTo<User, $this>
*/
public function sender(): BelongsTo
{
return $this->belongsTo(User::class)->withDefault([
'username' => 'System',
'id' => User::SYSTEM_USER_ID,
]);
}
/**
* Get the user that received the bon.
*
* @return BelongsTo<User, $this>
*/
public function receiver(): BelongsTo
{
return $this->belongsTo(User::class)->withDefault([
'username' => 'System',
'id' => User::SYSTEM_USER_ID,
]);
}
/**
* Get the exchange that was transacted.
*
* @return BelongsTo<BonExchange, $this>
*/
public function exchange(): BelongsTo
{
return $this->belongsTo(BonExchange::class)->withDefault([
'value' => 0,
'cost' => 0,
]);
}
}