Arcanedev\Currencies\Entities\Rate

Complexity

Total Complexity

10

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	from()	0	4	1
A	getFromCurrency()	0	4	1
A	to()	0	4	1
A	getToCurrency()	0	4	1
A	ratio()	0	4	1
A	make()	0	4	1
A	convert()	0	4	1
A	toJson()	0	4	1
A	toArray()	0	8	1

<?php namespace Arcanedev\Currencies\Entities;

use Arcanedev\Currencies\Contracts\Entities\Rate as RateContract;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;

/**
 * Class     Rate
 *
 * @package  Arcanedev\Currencies\Entities
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Rate implements RateContract, Arrayable, Jsonable
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * @var string
     */
    protected $from;

    /**
     * @var string
     */
    protected $to;

    /**
     * @var double
     */
    protected $ratio;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Rate constructor.
     *
     * @param  string  $from
     * @param  string  $to
     * @param  double  $ratio
     */
    public function __construct($from, $to, $ratio)
    {
        $this->from  = $from;
        $this->to    = $to;
        $this->ratio = $ratio;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the `from` currency iso.
     *
     * @return string
     */
    public function from()
    {
        return $this->from;
    }

    /**
     * Get the `from` currency.
     *
     * @return \Arcanedev\Currencies\Entities\Currency
     */
    public function getFromCurrency()
    {
        return currency_manager()->findOrFail($this->from());
    }

    /**
     * Get the `to` currency iso.
     *
     * @return string
     */
    public function to()
    {
        return $this->to;
    }

    /**
     * Get the `to` currency.
     *
     * @return \Arcanedev\Currencies\Entities\Currency
     */
    public function getToCurrency()
    {
        return currency_manager()->findOrFail($this->to());
    }

    /**
     * Get the rate ratio.
     *
     * @return float
     */
    public function ratio()
    {
        return $this->ratio;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make a rate instance.
     *
     * @param  string  $from
     * @param  string  $to
     * @param  double  $ratio
     *
     * @return self
     */
    public static function make($from, $to, $ratio)
    {
        return new self($from, $to, $ratio);
    }

    /**
     * Convert the amount.
     *
     * @param  double|int  $amount
     *
     * @return double|int
     */
    public function convert($amount)
    {
        return $amount * $this->ratio();
    }

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'from'  => $this->from(),
            'to'    => $this->to(),
            'ratio' => $this->ratio(),
        ];
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int $options
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }
}