BBSLab\NovaTranslation\Models\Locale

Complexity

Total Complexity

8

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	scopeAvailableInApi()	0	6	2
A	fallback()	0	4	1
A	havingIso()	0	4	1
A	getFlagAttribute()	0	10	3
A	resolveFlag()	0	7	1

<?php

namespace BBSLab\NovaTranslation\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

/**
 * @property int $id
 * @property string $iso
 * @property string $label
 * @property int $fallback_id
 * @property \BBSLab\NovaTranslation\Models\Locale $fallback
 * @property bool $available_in_api
 * @property string $flag
 * @property \Illuminate\Support\Carbon $created_at
 * @property \Illuminate\Support\Carbon $updated_at
 * @method static \Illuminate\Database\Eloquent\Builder availableInApi(array $args = [])
 */
class Locale extends Model
{
    /**
     * {@inheritdoc}
     */
    protected $table = 'locales';

    /**
     * {@inheritdoc}
     */
    protected $fillable = [
        'iso',
        'label',
        'fallback_id',
        'available_in_api',
    ];

    /**
     * {@inheritdoc}
     */
    protected $casts = [
        'fallback_id' => 'integer',
        'available_in_api' => 'boolean',
    ];

    protected $appends = ['flag'];

    /**
     * @var \Callable|null
     */
    public static $flagResolver;

    /**
     * Scope a query to only include locales available in API.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  array  $args
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeAvailableInApi($query, array $args = [])
    {
        $availableInApi = isset($args['available_in_api']) ? ! empty($args['available_in_api']) : true;

        return $query->where('available_in_api', '=', $availableInApi);
    }

    /**
     * Locale fallback relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function fallback(): BelongsTo
    {
        return $this->belongsTo(static::class, 'fallback_id');
    }

    /**
     * @param  string  $iso
     * @return \BBSLab\NovaTranslation\Models\Locale|null
     */
    public static function havingIso(string $iso)
    {
        return static::query()->firstWhere('iso', '=', $iso);
    }

    /**
     * Flag attribute accessor.
     *
     * @return string|null
     */
    public function getFlagAttribute(): ?string
    {
        if (! isset($this->attributes['flag'])) {
            $this->attributes['flag'] = static::$flagResolver
                ? call_user_func(static::$flagResolver, $this)
                : $this->resolveFlag();
        }

        return $this->attributes['flag'];
    }

    /**
     * Resolve flag using default behaviour.
     *
     * @return string|null
     */
    protected function resolveFlag(): ?string
    {
        $chunks = explode('-', $this->iso);
        $country = strtoupper(end($chunks));

        return config('nova-translation.flags.'.$country) ?? config('nova-translation.flags.default');
    }
}