Files
WMS/Modules/Countries/Models/Country.php
T
2026-09-21 10:14:57 +01:00

127 lines
3.1 KiB
PHP
Executable File

<?php
namespace Modules\Countries\Models;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
class Country extends Model
{
use HasFactory;
use SoftDeletes;
/** @var list<string> */
protected $fillable = [
'alpha2',
'alpha3',
'numeric',
'name',
'official_name',
'common_name',
'display_name',
'native_name',
'capital',
'flag_emoji',
'calling_code',
'tld',
'currency_code',
'currency_name',
'currency_symbol',
'languages',
'timezones',
'latitude',
'longitude',
'flag_svg_url',
'flag_png_url',
'ioc_code',
'fifa_code',
'postal_code_format',
'address_format',
'is_active',
'iso_status',
'independent',
'sovereignty_status',
'un_member',
'continent',
'region',
'subregion',
'intermediate_region',
'sort_order',
'last_synced_at',
'source',
'source_version',
'metadata',
];
/** @var array<string, string> */
protected $casts = [
'is_active' => 'boolean',
'independent' => 'boolean',
'un_member' => 'boolean',
'sort_order' => 'integer',
'last_synced_at' => 'datetime',
'languages' => 'array',
'timezones' => 'array',
'metadata' => 'array',
'latitude' => 'decimal:7',
'longitude' => 'decimal:7',
];
/**
* Use ISO 3166-1 alpha-2 for route model binding.
*/
public function getRouteKeyName(): string
{
return 'alpha2';
}
/**
* Effective display name used throughout WMS selectors and pages.
*/
public function getEffectiveNameAttribute(): string
{
return $this->display_name ?: $this->common_name ?: $this->name;
}
/**
* ISO 3166-2 subdivisions belonging to this country.
*/
public function subdivisions(): HasMany
{
return $this->hasMany(CountrySubdivision::class);
}
/**
* Resolve a country from alpha-2, alpha-3 or numeric ISO 3166-1 code.
*/
public function scopeForIsoCode(Builder $query, string $code): Builder
{
$normalised = strtoupper(trim($code));
return $query->where(function (Builder $nested) use ($normalised): void {
$nested->where('alpha2', $normalised)
->orWhere('alpha3', $normalised)
->orWhere('numeric', str_pad($normalised, 3, '0', STR_PAD_LEFT));
});
}
/**
* Scope active countries for business selectors.
*/
public function scopeActive(Builder $query): Builder
{
return $query->where('is_active', true);
}
/**
* Scope ordered countries for UI lists.
*/
public function scopeOrdered(Builder $query): Builder
{
return $query->orderBy('sort_order')->orderBy('name');
}
}