LiquidVolume::make() - Code Metrics - Inspection of "Merge pull request #4 from ARCANEDEV/feature-liqui..." - ARCANEDEV/Units - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0b32e2...2055d4 )

by ARCANEDEV

created 2016-08-22 20:11 UTC

LiquidVolume::make() A

↳ Parent: LiquidVolume

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	1
Bugs	0	Features	0

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

<?php namespace Arcanedev\Units\Measures;

use Arcanedev\Units\Bases\UnitMeasure;
use Arcanedev\Units\Contracts\LiquidVolume as LiquidVolumeContract;
use Arcanedev\Units\Traits\Calculatable;
use Illuminate\Support\Arr;

/**
 * Class     LiquidVolume
 *
 * @package  Arcanedev\Units\Measures
 * @author   ARCANEDEV <[email protected]>
 */
class LiquidVolume extends UnitMeasure implements LiquidVolumeContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use Calculatable;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Volume constructor.
     *
     * @param  float|int  $value
     * @param  string     $unit
     * @param  array      $options
     */
    public function __construct($value = 0, $unit = self::L, array $options = [])
    {
        $this->setValue($value);
        $this->setUnit($unit);
        $this->setSymbols(Arr::get($options, 'symbols', []));
        $this->setFormat(
            Arr::get($options, 'decimals', 0),
            Arr::get($options, 'separators.decimal', ','),
            Arr::get($options, 'separators.thousands', '.')
        );
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the symbol's names.
     *
     * @return array
     */
    public static function names()
    {
        return array_combine(static::units(), [
            'kilolitre',
            'hectolitre',
            'decalitre',
            'litre',
            'decilitre',
            'centilitre',
            'millilitre',
        ]);
    }

    /**
     * Get the symbol name.
     *
     * @param  string  $unit
     *
     * @return string
     */
    public static function getSymbolName($unit)
    {
        static::checkUnit($unit);

        return Arr::get(static::names(), $unit);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make a volume instance.
     *
     * @param  float|int  $value
     * @param  string     $unit
     * @param  array      $options
     *
     * @return \Arcanedev\Units\Contracts\LiquidVolume
     */
    public static function make($value = 0, $unit = self::L, array $options = [])
    {
        return new static($value, $unit, $options);
    }

    /**
     * Convert the volume to the given unit.
     *
     * @param  string  $to
     *
     * @return \Arcanedev\Units\Contracts\LiquidVolume
     */
    public function to($to)
    {
        if ($to === $this->unit()) return $this;

        $value = static::convert($this->unit(), $to, $this->value());

        return static::make($value, $to);
    }

    /**
     * Convert the volume.
     *
     * @param  string     $from
     * @param  string     $to
     * @param  float|int  $value
     *
     * @return float|int
     */
    public static function convert($from, $to, $value)
    {
        return $value * static::getRatio($to, $from);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Calculation Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Add the volume.
     *
     * @param  float|int  $value
     * @param  string     $unit
     *
     * @return \Arcanedev\Units\Contracts\LiquidVolume
     */
    public function addVolume($value, $unit = self::L)
    {
        return $this->add(
            self::make($value, $unit)
        );
    }

    /**
     * Sub the volume.
     *
     * @param  float|int  $value
     * @param  string     $unit
     *
     * @return \Arcanedev\Units\Contracts\LiquidVolume
     */
    public function subVolume($value, $unit = self::L)
    {
        return $this->sub(
            static::make($value, $unit)
        );
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the volume convert ratio.
     *
     * @param  string  $to
     * @param  string  $from
     *
     * @return float|int
     */
    protected static function getRatio($to, $from)
    {
        static::checkUnit($from);
        static::checkUnit($to);

        if ($to === $from) return 1;

        $ratios = static::getRatios();

        return $ratios[$to] / $ratios[$from];
    }

    /**
     * Get all the volume ratios.
     *
     * @return array
     */
    protected static function getRatios()
    {
        $rate   = 10;
        $ratios = [
            static::KL  => 0,
            static::HL  => 1,
            static::DAL => 2,
            static::L   => 3,
            static::DL  => 4,
            static::CL  => 5,
            static::ML  => 6,
        ];

        return array_map(function ($ratio) use ($rate) {
            return static::calculate($rate, '^', $ratio);
        }, $ratios);
    }
}


1		<?php namespace Arcanedev\Units\Measures;
2
3		use Arcanedev\Units\Bases\UnitMeasure;
4		use Arcanedev\Units\Contracts\LiquidVolume as LiquidVolumeContract;
5		use Arcanedev\Units\Traits\Calculatable;
6		use Illuminate\Support\Arr;
7
8		/**
9		* Class LiquidVolume
10		*
11		* @package Arcanedev\Units\Measures
12		* @author ARCANEDEV <[email protected]>
13		*/
14		class LiquidVolume extends UnitMeasure implements LiquidVolumeContract
15		{
16		/* ------------------------------------------------------------------------------------------------
17		\| Traits
18		\| ------------------------------------------------------------------------------------------------
19		*/
20		use Calculatable;
21
22		/* ------------------------------------------------------------------------------------------------
23		\| Constructor
24		\| ------------------------------------------------------------------------------------------------
25		*/
26		/**
27		* Volume constructor.
28		*
29		* @param float\|int $value
30		* @param string $unit
31		* @param array $options
32		*/
33	168	public function __construct($value = 0, $unit = self::L, array $options = [])
34		{
35	168	$this->setValue($value);
36	168	$this->setUnit($unit);
37	168	$this->setSymbols(Arr::get($options, 'symbols', []));
38	168	$this->setFormat(
39	168	Arr::get($options, 'decimals', 0),
40	168	Arr::get($options, 'separators.decimal', ','),
41	168	Arr::get($options, 'separators.thousands', '.')
42	126	);
43	168	}
44
45		/* ------------------------------------------------------------------------------------------------
46		\| Getters & Setters
47		\| ------------------------------------------------------------------------------------------------
48		*/
49		/**
50		* Get the symbol's names.
51		*
52		* @return array
53		*/
54	8	public static function names()
55		{
56	8	return array_combine(static::units(), [
57	8	'kilolitre',
58	6	'hectolitre',
59	6	'decalitre',
60	6	'litre',
61	6	'decilitre',
62	6	'centilitre',
63	6	'millilitre',
64	6	]);
65		}
66
67		/**
68		* Get the symbol name.
69		*
70		* @param string $unit
71		*
72		* @return string
73		*/
74	8	public static function getSymbolName($unit)
75		{
76	8	static::checkUnit($unit);
77
78	8	return Arr::get(static::names(), $unit);
79		}
80
81		/* ------------------------------------------------------------------------------------------------
82		\| Main Functions
83		\| ------------------------------------------------------------------------------------------------
84		*/
85		/**
86		* Make a volume instance.
87		*
88		* @param float\|int $value
89		* @param string $unit
90		* @param array $options
91		*
92		* @return \Arcanedev\Units\Contracts\LiquidVolume
93		*/
94	72	public static function make($value = 0, $unit = self::L, array $options = [])
95		{
96	72	return new static($value, $unit, $options);
97		}
98
99		/**
100		* Convert the volume to the given unit.
101		*
102		* @param string $to
103		*
104		* @return \Arcanedev\Units\Contracts\LiquidVolume
105		*/
106	72	public function to($to)
107		{
108	72	if ($to === $this->unit()) return $this;
109
110	24	$value = static::convert($this->unit(), $to, $this->value());
111
112	24	return static::make($value, $to);
113		}
114
115		/**
116		* Convert the volume.
117		*
118		* @param string $from
119		* @param string $to
120		* @param float\|int $value
121		*
122		* @return float\|int
123		*/
124	24	public static function convert($from, $to, $value)
125		{
126	24	return $value * static::getRatio($to, $from);
127		}
128
129		/* ------------------------------------------------------------------------------------------------
130		\| Calculation Functions
131		\| ------------------------------------------------------------------------------------------------
132		*/
133		/**
134		* Add the volume.
135		*
136		* @param float\|int $value
137		* @param string $unit
138		*
139		* @return \Arcanedev\Units\Contracts\LiquidVolume
140		*/
141	16	public function addVolume($value, $unit = self::L)
142		{
143	16	return $this->add(
144	16	self::make($value, $unit)
145	12	);
146		}
147
148		/**
149		* Sub the volume.
150		*
151		* @param float\|int $value
152		* @param string $unit
153		*
154		* @return \Arcanedev\Units\Contracts\LiquidVolume
155		*/
156	16	public function subVolume($value, $unit = self::L)
157		{
158	16	return $this->sub(
159	16	static::make($value, $unit)
160	12	);
161		}
162
163		/* ------------------------------------------------------------------------------------------------
164		\| Other Functions
165		\| ------------------------------------------------------------------------------------------------
166		*/
167		/**
168		* Get the volume convert ratio.
169		*
170		* @param string $to
171		* @param string $from
172		*
173		* @return float\|int
174		*/
175	24	protected static function getRatio($to, $from)
176		{
177	24	static::checkUnit($from);
178	24	static::checkUnit($to);
179
180	24	if ($to === $from) return 1;
181
182	24	$ratios = static::getRatios();
183
184	24	return $ratios[$to] / $ratios[$from];
185		}
186
187		/**
188		* Get all the volume ratios.
189		*
190		* @return array
191		*/
192	24	protected static function getRatios()
193		{
194	24	$rate = 10;
195		$ratios = [
196	24	static::KL => 0,
197	24	static::HL => 1,
198	24	static::DAL => 2,
199	24	static::L => 3,
200	24	static::DL => 4,
201	24	static::CL => 5,
202	24	static::ML => 6,
203	18	];
204
205	24	return array_map(function ($ratio) use ($rate) {
206	24	return static::calculate($rate, '^', $ratio);
207	24	}, $ratios);
208		}
209		}
210

ARCANEDEV / Units

Push — master ( 0b32e2...2055d4 )

LiquidVolume::make() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like