ldc-showroom-bo/app/Models/Brand.php

145 lines
4.4 KiB
PHP

<?php
namespace App\Models;
use App\Casts\HtmlColor;
use App\Helpers\ShowroomFileHelper;
use App\Traits\Models\ActivityLog;
use App\Traits\Models\HasTranslations;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasManyThrough;
use Illuminate\Support\Str;
use Stancl\Tenancy\Database\Concerns\BelongsToTenant;
use Uwil\LaravelCommon\Helpers\FileHelper;
use App\Lib\Helpers\ToolboxHelper;
use Illuminate\Http\UploadedFile;
/**
* @property string $name Name of the brand.
* @property string $slug Slug of the name for the brand.
* @property string $color HTML Color string.
* @property string $picture Picture path for the brand.
* @property boolean $status Visible ? (présent dans l'export).
* @property string $tenant_id Id of the related tenant.
* @property-read \Illuminate\Support\Carbon $created_at Created date.
* @property-read \Illuminate\Support\Carbon $updated_at Updated date.
*
* @property-read \Illuminate\Database\Eloquent\Collection<\App\Models\Range> $ranges Ranges Has-many relationship.
*/
class Brand extends Model
{
use HasFactory;
use HasTranslations;
use BelongsToTenant;
use ActivityLog;
/**
* The attributes that are mass assignable.
*
* @var list<string>
*/
protected $fillable = [
'name',
'color',
'picture',
'status',
];
/**
* Translatable fields array
*
* @var array<int, string>
*/
public $translatable = [
'name',
'slug',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'color' => HtmlColor::class,
'status' => 'bool',
];
/**
* Perform any actions required after the model boots.
*
* @return void
*/
protected static function booted(): void
{
static::creating(function (self $model) {
// * ASSERTIONS
self::assertNameIsUnique($model->name);
// * TRANSFORMATIONS
$model->slug = Str::slug($model->name);
/** @phpstan-ignore-next-line */
if ($model->picture instanceof UploadedFile) {
$model->picture = ShowroomFileHelper::storeFileWithUUIDName($model->picture, $model);
}
});
static::updating(function (self $model) {
// * ASSERTIONS
self::assertNameIsUnique($model->name, $model->id);
// * TRANSFORMATIONS
$model->slug = Str::slug($model->name);
/** @phpstan-ignore-next-line */
if ($model->picture instanceof UploadedFile) {
$model->picture = ShowroomFileHelper::storeFileWithUUIDName($model->picture, $model);
}
});
static::updated(function (self $model) {
FileHelper::removeOldFile($model, 'picture');
});
static::deleted(function (self $model) {
FileHelper::removeFile($model, 'picture');
});
}
// * RELATIONSHIPS
/**
* Get all of the ranges for the Brand
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany<\App\Models\Range, $this>
*/
public function ranges(): HasMany
{
return $this->hasMany(Range::class);
}
/**
* Get all of the products for the Brand
*
* @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
*/
public function products(): HasManyThrough
{
return $this->hasManyThrough(Product::class, Range::class);
}
// * METHODS
/**
* Asserts using validation that the name is unique
*
* @param string|null $name
* @param integer|null $id
* @return void
* @throws \Illuminate\Validation\ValidationException If name already exists.
*/
private static function assertNameIsUnique(string|null $name, ?int $id = null)
{
$table = (new self())->getTable();
ToolboxHelper::assertFieldIsUnique($table, 'name', $name, $id);
ToolboxHelper::assertFieldIsUnique($table, 'slug', Str::slug($name), $id);
}
}