CurrencyManager::format() - Code Metrics - Inspection of "Merge pull request #10 from ARCANEDEV/develop" - ARCANEDEV/Currencies - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0820ba...224783 )

by ARCANEDEV

created 2016-06-27 03:43 UTC

CurrencyManager::format() A

↳ Parent: CurrencyManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	2
b	0
f	0
nc	1
nop	3
dl	0
loc	4
rs	10
ccs	2
cts	2
cp	1
crap	1

<?php namespace Arcanedev\Currencies;

use Arcanedev\Currencies\Contracts\CurrencyManager as CurrencyManagerContract;
use Arcanedev\Currencies\Entities\CurrencyCollection;
use Illuminate\Support\Arr;

/**
 * Class     CurrencyManager
 *
 * @package  Arcanedev\Currencies
 * @author   ARCANEDEV <[email protected]>
 */
class CurrencyManager implements CurrencyManagerContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Default currency.
     *
     * @var string
     */
    protected $default;

    /**
     * Supported currencies.
     *
     * @var array
     */
    protected $supported      = [];

    /**
     * Non ISO Currencies included.
     *
     * @var bool
     */
    protected $nonIsoIncluded = false;

    /**
     * The currencies collection.
     *
     * @var  \Arcanedev\Currencies\Entities\CurrencyCollection
     */
    protected $currencies;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * CurrencyManager constructor.
     *
     * @param  array  $configs
     */
    public function __construct(array $configs)
    {
        $this->default        = Arr::get($configs, 'default', 'USD');
        $this->supported      = Arr::get($configs, 'supported', ['USD']);

        $this->nonIsoIncluded = Arr::get($configs, 'include-non-iso', false);
        $this->currencies     = new CurrencyCollection;
    }

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

    /**
     * Get the default currency entity.
     *
     * @return \Arcanedev\Currencies\Contracts\Entities\Currency
     */
    public function getDefaultCurrency()
    {
        return $this->currencies->get($this->getDefault());
    }

    /**
     * Get supported currencies (iso codes).
     *
     * @return array
     */
    public function getSupported()
    {
        return $this->supported;
    }

    /**
     * Check if non ISO Currencies included.
     *
     * @return bool
     */
    public function isNonIsoIncluded()
    {
        return $this->nonIsoIncluded;
    }

    /**
     * Get the currencies collection.
     *
     * @return \Arcanedev\Currencies\Entities\CurrencyCollection
     */
    public function currencies()
    {
        return $this->currencies;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Load the currencies.
     *
     * @param  array  $currencies
     *
     * @return self
     */
    public function load(array $currencies)
    {
        $this->currencies()->load($currencies, $this->nonIsoIncluded);

        return $this;
    }

    /**
     * Get a currency from the collection by iso code.
     *
     * @param  string      $iso
     * @param  mixed|null  $default
     *
     * @return \Arcanedev\Currencies\Contracts\Entities\Currency
     */
    public function get($iso, $default = null)
    {
        return $this->currencies()->get($iso, $default);
    }

    /**
     * Get a currency or fail if not exists.
     *
     * @param  string  $iso
     *
     * @return \Arcanedev\Currencies\Contracts\Entities\Currency
     *
     * @throws \Arcanedev\Currencies\Exceptions\CurrencyNotFoundException
     */
    public function findOrFail($iso)
    {
        return $this->currencies()->findOrFails($iso);
    }

    /**
     * Get the supported currencies collection.
     *
     * @return \Arcanedev\Currencies\Entities\CurrencyCollection
     */
    public function getSupportedCurrencies()
    {
        $currencies = $this->currencies();
        $supported  = array_map(function ($iso) use ($currencies) {
            return $currencies->findOrFails($iso);
        }, array_combine($this->getSupported(), $this->getSupported()));

        return CurrencyCollection::make($supported);
    }

    /**
     * Format the amount.
     *
     * @param  string      $iso
     * @param  double|int  $amount
     * @param  int         $decimals
     *
     * @return string
     *
     * @throws \Arcanedev\Currencies\Exceptions\CurrencyNotFoundException
     */
    public function format($iso, $amount, $decimals = 2)
    {
        return $this->findOrFail($iso)->format($amount, $decimals);
    }

    /**
     * Format the amount by the default iso.
     *
     * @param  double|int  $amount
     * @param  int         $decimals
     *
     * @return string
     *
     * @throws \Arcanedev\Currencies\Exceptions\CurrencyNotFoundException
     */
    public function formatDefault($amount, $decimals = 2)
    {
        return $this->format($this->getDefault(), $amount, $decimals);
    }

    /**
     * Get the currency symbol by iso code.
     *
     * @param  string  $iso
     *
     * @return string
     */
    public function symbol($iso)
    {
        return $this->findOrFail($iso)->symbol;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }
}


1		<?php namespace Arcanedev\Currencies;
2
3		use Arcanedev\Currencies\Contracts\CurrencyManager as CurrencyManagerContract;
4		use Arcanedev\Currencies\Entities\CurrencyCollection;
5		use Illuminate\Support\Arr;
6
7		/**
8		* Class CurrencyManager
9		*
10		* @package Arcanedev\Currencies
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class CurrencyManager implements CurrencyManagerContract
14		{
15		/* ------------------------------------------------------------------------------------------------
16		\| Properties
17		\| ------------------------------------------------------------------------------------------------
18		*/
19		/**
20		* Default currency.
21		*
22		* @var string
23		*/
24		protected $default;
25
26		/**
27		* Supported currencies.
28		*
29		* @var array
30		*/
31		protected $supported = [];
32
33		/**
34		* Non ISO Currencies included.
35		*
36		* @var bool
37		*/
38		protected $nonIsoIncluded = false;
39
40		/**
41		* The currencies collection.
42		*
43		* @var \Arcanedev\Currencies\Entities\CurrencyCollection
44		*/
45		protected $currencies;
46
47		/* ------------------------------------------------------------------------------------------------
48		\| Constructor
49		\| ------------------------------------------------------------------------------------------------
50		*/
51		/**
52		* CurrencyManager constructor.
53		*
54		* @param array $configs
55		*/
56	540	public function __construct(array $configs)
57		{
58	540	$this->default = Arr::get($configs, 'default', 'USD');
59	540	$this->supported = Arr::get($configs, 'supported', ['USD']);
		0 ignored issues – show Documentation Bug introduced 2016-06-23 05:47 UTC by Report Bug Copy Issue Report It seems like `\Illuminate\Support\Arr:...pported', array('USD'))` of type `*` is incompatible with the declared type `array` of property `$supported`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
60	540	$this->nonIsoIncluded = Arr::get($configs, 'include-non-iso', false);
61	540	$this->currencies = new CurrencyCollection;
62	540	}
63
64		/* ------------------------------------------------------------------------------------------------
65		\| Getters & Setters
66		\| ------------------------------------------------------------------------------------------------
67		*/
68		/**
69		* Get the default currency iso code.
70		*
71		* @return string
72		*/
73	48	public function getDefault()
74		{
75	48	return $this->default;
76		}
77
78		/**
79		* Get the default currency entity.
80		*
81		* @return \Arcanedev\Currencies\Contracts\Entities\Currency
82		*/
83	12	public function getDefaultCurrency()
84		{
85	12	return $this->currencies->get($this->getDefault());
86		}
87
88		/**
89		* Get supported currencies (iso codes).
90		*
91		* @return array
92		*/
93	48	public function getSupported()
94		{
95	48	return $this->supported;
96		}
97
98		/**
99		* Check if non ISO Currencies included.
100		*
101		* @return bool
102		*/
103	12	public function isNonIsoIncluded()
104		{
105	12	return $this->nonIsoIncluded;
106		}
107
108		/**
109		* Get the currencies collection.
110		*
111		* @return \Arcanedev\Currencies\Entities\CurrencyCollection
112		*/
113	540	public function currencies()
114		{
115	540	return $this->currencies;
116		}
117
118		/* ------------------------------------------------------------------------------------------------
119		\| Main Functions
120		\| ------------------------------------------------------------------------------------------------
121		*/
122		/**
123		* Load the currencies.
124		*
125		* @param array $currencies
126		*
127		* @return self
128		*/
129	540	public function load(array $currencies)
130		{
131	540	$this->currencies()->load($currencies, $this->nonIsoIncluded);
132
133	540	return $this;
134		}
135
136		/**
137		* Get a currency from the collection by iso code.
138		*
139		* @param string $iso
140		* @param mixed\|null $default
141		*
142		* @return \Arcanedev\Currencies\Contracts\Entities\Currency
143		*/
144	12	public function get($iso, $default = null)
145		{
146	12	return $this->currencies()->get($iso, $default);
147		}
148
149		/**
150		* Get a currency or fail if not exists.
151		*
152		* @param string $iso
153		*
154		* @return \Arcanedev\Currencies\Contracts\Entities\Currency
155		*
156		* @throws \Arcanedev\Currencies\Exceptions\CurrencyNotFoundException
157		*/
158	60	public function findOrFail($iso)
159		{
160	60	return $this->currencies()->findOrFails($iso);
161		}
162
163		/**
164		* Get the supported currencies collection.
165		*
166		* @return \Arcanedev\Currencies\Entities\CurrencyCollection
167		*/
168	12	public function getSupportedCurrencies()
169		{
170	12	$currencies = $this->currencies();
171	12	$supported = array_map(function ($iso) use ($currencies) {
172	12	return $currencies->findOrFails($iso);
173	12	}, array_combine($this->getSupported(), $this->getSupported()));
174
175	12	return CurrencyCollection::make($supported);
176		}
177
178		/**
179		* Format the amount.
180		*
181		* @param string $iso
182		* @param double\|int $amount
183		* @param int $decimals
184		*
185		* @return string
186		*
187		* @throws \Arcanedev\Currencies\Exceptions\CurrencyNotFoundException
188		*/
189	24	public function format($iso, $amount, $decimals = 2)
190		{
191	24	return $this->findOrFail($iso)->format($amount, $decimals);
192		}
193
194		/**
195		* Format the amount by the default iso.
196		*
197		* @param double\|int $amount
198		* @param int $decimals
199		*
200		* @return string
201		*
202		* @throws \Arcanedev\Currencies\Exceptions\CurrencyNotFoundException
203		*/
204	12	public function formatDefault($amount, $decimals = 2)
205		{
206	12	return $this->format($this->getDefault(), $amount, $decimals);
207		}
208
209		/**
210		* Get the currency symbol by iso code.
211		*
212		* @param string $iso
213		*
214		* @return string
215		*/
216	12	public function symbol($iso)
217		{
218	12	return $this->findOrFail($iso)->symbol;
		0 ignored issues – show Bug introduced 2016-06-26 22:54 UTC by Report Bug Copy Issue Report Accessing `symbol` on the interface `Arcanedev\Currencies\Contracts\Entities\Currency` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
219		}
220		}
221

ARCANEDEV / Currencies

Push — master ( 0820ba...224783 )

CurrencyManager::format() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like