App\Entities\Currency\Currency

Complexity

Total Complexity

8

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Test Coverage

Coverage

12.5%

Importance

Changes	1
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCountries()	0	3	1
A	getIsoNumeric()	0	3	1
A	getIsoAlpha()	0	3	1
A	countries()	0	3	1
A	getName()	0	3	1
A	getDecimalPrecision()	0	3	1
A	getSymbol()	0	3	1
A	getExchangeRate()	0	3	1

<?php
/**
 * Currency Entity.
 *
 * @package App\Entities\Currency
 *
 * @author    Nick Menke <nick@nlmenke.net>
 * @copyright 2018-2020 Nick Menke
 *
 * @link https://github.com/nlmenke/vertebrae
 */

declare(strict_types=1);

namespace App\Entities\Currency;

use App\Entities\AbstractEntity;
use App\Entities\Country\Country;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * The Currency entity class.
 *
 * This class contains any functions required to access and manipulate currency
 * models.
 *
 * @since x.x.x introduced
 */
class Currency extends AbstractEntity
{
    use SoftDeletes;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'iso_alpha',
        'iso_numeric',
        'name',
        'symbol',
        'decimal_precision',
        'exchange_rate',
    ];

    /**
     * The countries relationship instance.
     *
     * @return HasMany
     */
    public function countries(): HasMany
    {
        return $this->hasMany(Country::class);
    }

    /**
     * Get the countries attribute.
     *
     * @return Country[]|Collection
     */
    public function getCountries()
    {
        return $this->getAttribute('countries');
    }

    /**
     * Get the decimal_precision attribute.
     *
     * @return int
     */
    public function getDecimalPrecision(): int
    {
        return $this->getAttribute('decimal_precision');
    }

    /**
     * Get the exchange_rate attribute.
     *
     * @return float
     */
    public function getExchangeRate(): float
    {
        return $this->getAttribute('exchange_rate');
    }

    /**
     * Get the iso_alpha attribute.
     *
     * @return string
     */
    public function getIsoAlpha(): string
    {
        return $this->getAttribute('iso_alpha');
    }

    /**
     * Get the iso_numeric attribute.
     *
     * @return string
     */
    public function getIsoNumeric(): string
    {
        return $this->getAttribute('iso_numeric');
    }

    /**
     * Get the name attribute.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->getAttribute('name');
    }

    /**
     * Get the symbol attribute.
     *
     * @return string
     */
    public function getSymbol(): string
    {
        return $this->getAttribute('symbol');
    }
}