RunOpenCode\ExchangeRate\Configuration

Complexity

Total Complexity

5

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getCurrencyCode()	0	4	1
A	getRateType()	0	4	1
A	getSourceName()	0	4	1
A	getExtraConfiguration()	0	4	1

<?php
/*
 * This file is part of the Exchange Rate package, an RunOpenCode project.
 *
 * (c) 2017 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\ExchangeRate;

use RunOpenCode\ExchangeRate\Utils\CurrencyCodeUtil;

/**
 * Class Configuration
 *
 * Configuration defines which rates should be acquired from which source, and holds additional custom cofiguration
 * parameters, if required.
 *
 * @package RunOpenCode\ExchangeRate
 *
 * @codeCoverageIgnore
 */
class Configuration
{
    /**
     * @var string
     */
    private $currencyCode;

    /**
     * @var string
     */
    private $rateType;

    /**
     * @var string
     */
    private $sourceName;

    /**
     * @var array
     */
    private $extraConfiguration;

    /**
     * Configuration constructor.
     *
     * @param $currencyCode
     * @param $rateType
     * @param $sourceName
     * @param array $extraConfiguration
     */
    public function __construct($currencyCode, $rateType, $sourceName, array $extraConfiguration = array())
    {
        $this->currencyCode = CurrencyCodeUtil::clean($currencyCode);
        $this->rateType = $rateType;
        $this->sourceName = $sourceName;
        $this->extraConfiguration = $extraConfiguration;
    }

    /**
     * Get configured currency code.
     *
     * @return string
     */
    public function getCurrencyCode()
    {
        return $this->currencyCode;
    }

    /**
     * Get configured rate type.
     *
     * @return string
     */
    public function getRateType()
    {
        return $this->rateType;
    }

    /**
     * Get configured source.
     *
     * @return string
     */
    public function getSourceName()
    {
        return $this->sourceName;
    }

    /**
     * Get additional configuration paramaters, if applicable.
     *
     * @return array
     */
    public function getExtraConfiguration()
    {
        return $this->extraConfiguration;
    }
}