Number::getNumber() - Code Metrics - thelia/math-tools - Measure and Improve Code Quality continuously with Scrutinizer

Number::getNumber() A
last analyzed 2015-12-04 08:13 UTC

↳ Parent: Number

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
rs	9.4286
cc	2
eloc	5
nc	2
nop	2

<?php
/*************************************************************************************/
/*      This file is part of the Thelia package.                                     */
/*                                                                                   */
/*      Copyright (c) OpenStudio                                                     */
/*      email : [email protected]                                                       */
/*      web : http://www.thelia.net                                                  */

/*                                                                                   */
/*      For the full copyright and license information, please view the LICENSE.txt  */
/*      file that was distributed with this source code.                             */
/*************************************************************************************/

namespace Thelia\Math;

/**
 * Class Number
 * @package Lovenunu\Math
 * @author Benjamin Perche <[email protected]>
 */
class Number implements \Serializable, \JsonSerializable
{
    // Regex to find correct numbers
    const NUMBER_PATTERN = "#^\d+(\.\d+)?$#";

    // Internal variables
    protected $dividend;

    protected $divisor;

    // --- Object construction ------------
    public function __construct($number = null)
    {
        list($this->dividend, $this->divisor) = $this->retrieve($number);
    }

    protected function initialize($dividend, $divisor)
    {
        $this->dividend = $dividend;

        $this->divisor = $divisor;
    }

    // --- Number processor ------------

    protected function retrieve($number)
    {
        $dividend = 0;
        $divisor = 1;

        if ($number !== null) {
            if (is_scalar($number) && preg_match(static::NUMBER_PATTERN, $number)) {
                $dividend = (int) str_replace(".", "", $number);

                if (false !== $pos = strpos($number, ".")) {
                    $divisor = pow(10, strlen($number) - $pos - 1);
                }
            } elseif ($number instanceof $this) {
                $dividend = $number->getDividend();
                $divisor = $number->getDivisor();
            } else {
                throw new \InvalidArgumentException(
                    "The given price is not valid"
                );
            }
        }

        return array($dividend, $divisor);
    }

    protected function computeDividend($askedDividend, $askedDivisor, Number $number)
    {
        if ($number->divisor !== $askedDivisor) {
            $number->dividend *= $askedDivisor;
            $askedDividend *= $number->divisor;

            $number->divisor *= $askedDivisor;
        }

        return $askedDividend;
    }

    protected function simplify()
    {
        if (1 < $gcd = GCD::getGCD($this->dividend, $this->divisor)) {
            $this->dividend /= $gcd;
            $this->divisor /= $gcd;
        }
    }

    // --- Operations ------------

    public function add($number)

    {
        list($askedDividend, $askedDivisor) = $this->retrieve($number);
        $returnNumber = clone $this;

        $askedDividend = $this->computeDividend($askedDividend, $askedDivisor, $returnNumber);

        /**
         * If divisors are different, just multiply them
         */

        $returnNumber->dividend += $askedDividend;
        $returnNumber->simplify();

        return $returnNumber;
    }

    public function sub($number)

    {
        list($askedDividend, $askedDivisor) = $this->retrieve($number);
        $returnNumber = clone $this;

        $askedDividend = $this->computeDividend($askedDividend, $askedDivisor, $returnNumber);

        /**
         * If divisors are different, just multiply them
         */

        $returnNumber->dividend -= $askedDividend;
        $returnNumber->simplify();

        return $returnNumber;
    }

    public function multiply($number)

    {
        list($askedDividend, $askedDivisor) = $this->retrieve($number);
        $returnNumber = clone $this;

        $returnNumber->dividend *= $askedDividend;
        $returnNumber->divisor *= $askedDivisor;
        $returnNumber->simplify();

        return $returnNumber;
    }

    public function divide($number)

    {
        list($askedDividend, $askedDivisor) = $this->retrieve($number);
        $returnNumber = clone $this;

        $returnNumber->dividend *= $askedDivisor;
        $returnNumber->divisor *= $askedDividend;
        $returnNumber->simplify();

        return $returnNumber;
    }

    // --- Results ------------

    public function getNumber($roundPrecision = 2, $roundMode = PHP_ROUND_HALF_UP)
    {
        $value = $this->dividend / $this->divisor;

        if ($roundPrecision >= 0) {
            $value = round($value, $roundPrecision, $roundMode);
        }

        return $value;
    }

    // --- Accessor ------------

    /**
     * @return mixed
     */
    public function getDividend()
    {
        return $this->dividend;
    }

    /**
     * @return mixed
     */
    public function getDivisor()
    {
        return $this->divisor;
    }

    // --- Interfaces implementation ------------
    /**
     * (PHP 5 &gt;= 5.1.0)<br/>
     * String representation of object
     * @link http://php.net/manual/en/serializable.serialize.php
     * @return string the string representation of the object or null
     */
    public function serialize()
    {
        return json_encode(array($this->dividend, $this->divisor));
    }

    /**
     * (PHP 5 &gt;= 5.1.0)<br/>
     * Constructs the object
     * @link http://php.net/manual/en/serializable.unserialize.php
     * @param string $serialized <p>
     * The string representation of the object.
     * </p>
     * @return void
     */
    public function unserialize($serialized)
    {
        list($this->dividend, $this->divisor) = json_decode($serialized, true);
    }

    /**
     * (PHP 5 &gt;= 5.4.0)<br/>
     * Specify data which should be serialized to JSON
     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
     * @return mixed data which can be serialized by <b>json_encode</b>,
     * which is a value of any type other than a resource.
     */
    function jsonSerialize()

    {
        return $this->serialize();
    }

}


1		<?php
2		/*************************************************************************************/
3		/* This file is part of the Thelia package. */
4		/* */
5		/* Copyright (c) OpenStudio */
6		/* email : [email protected] */
7		/* web : http://www.thelia.net */
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-12-04 08:07 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
8		/* */
9		/* For the full copyright and license information, please view the LICENSE.txt */
10		/* file that was distributed with this source code. */
11		/*************************************************************************************/
12
13		namespace Thelia\Math;
14
15		/**
16		* Class Number
17		* @package Lovenunu\Math
18		* @author Benjamin Perche <[email protected]>
19		*/
20		class Number implements \Serializable, \JsonSerializable
21		{
22		// Regex to find correct numbers
23		const NUMBER_PATTERN = "#^\d+(\.\d+)?$#";
24
25		// Internal variables
26		protected $dividend;
27
28		protected $divisor;
29
30		// --- Object construction ------------
31		public function __construct($number = null)
32		{
33		list($this->dividend, $this->divisor) = $this->retrieve($number);
34		}
35
36		protected function initialize($dividend, $divisor)
37		{
38		$this->dividend = $dividend;
39
40		$this->divisor = $divisor;
41		}
42
43		// --- Number processor ------------
44
45		protected function retrieve($number)
46		{
47		$dividend = 0;
48		$divisor = 1;
49
50		if ($number !== null) {
51		if (is_scalar($number) && preg_match(static::NUMBER_PATTERN, $number)) {
52		$dividend = (int) str_replace(".", "", $number);
53
54		if (false !== $pos = strpos($number, ".")) {
55		$divisor = pow(10, strlen($number) - $pos - 1);
56		}
57		} elseif ($number instanceof $this) {
58		$dividend = $number->getDividend();
59		$divisor = $number->getDivisor();
60		} else {
61		throw new \InvalidArgumentException(
62		"The given price is not valid"
63		);
64		}
65		}
66
67		return array($dividend, $divisor);
68		}
69
70		protected function computeDividend($askedDividend, $askedDivisor, Number $number)
71		{
72		if ($number->divisor !== $askedDivisor) {
73		$number->dividend *= $askedDivisor;
74		$askedDividend *= $number->divisor;
75
76		$number->divisor *= $askedDivisor;
77		}
78
79		return $askedDividend;
80		}
81
82		protected function simplify()
83		{
84		if (1 < $gcd = GCD::getGCD($this->dividend, $this->divisor)) {
85		$this->dividend /= $gcd;
86		$this->divisor /= $gcd;
87		}
88		}
89
90		// --- Operations ------------
91
92	View Code Duplication	public function add($number)
		0 ignored issues – show Duplication introduced 2015-12-04 08:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
93		{
94		list($askedDividend, $askedDivisor) = $this->retrieve($number);
95		$returnNumber = clone $this;
96
97		$askedDividend = $this->computeDividend($askedDividend, $askedDivisor, $returnNumber);
98
99		/**
100		* If divisors are different, just multiply them
101		*/
102
103		$returnNumber->dividend += $askedDividend;
104		$returnNumber->simplify();
105
106		return $returnNumber;
107		}
108
109	View Code Duplication	public function sub($number)
		0 ignored issues – show Duplication introduced 2015-12-04 08:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		{
111		list($askedDividend, $askedDivisor) = $this->retrieve($number);
112		$returnNumber = clone $this;
113
114		$askedDividend = $this->computeDividend($askedDividend, $askedDivisor, $returnNumber);
115
116		/**
117		* If divisors are different, just multiply them
118		*/
119
120		$returnNumber->dividend -= $askedDividend;
121		$returnNumber->simplify();
122
123		return $returnNumber;
124		}
125
126	View Code Duplication	public function multiply($number)
		0 ignored issues – show Duplication introduced 2015-12-04 08:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
127		{
128		list($askedDividend, $askedDivisor) = $this->retrieve($number);
129		$returnNumber = clone $this;
130
131		$returnNumber->dividend *= $askedDividend;
132		$returnNumber->divisor *= $askedDivisor;
133		$returnNumber->simplify();
134
135		return $returnNumber;
136		}
137
138	View Code Duplication	public function divide($number)
		0 ignored issues – show Duplication introduced 2015-12-04 08:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
139		{
140		list($askedDividend, $askedDivisor) = $this->retrieve($number);
141		$returnNumber = clone $this;
142
143		$returnNumber->dividend *= $askedDivisor;
144		$returnNumber->divisor *= $askedDividend;
145		$returnNumber->simplify();
146
147		return $returnNumber;
148		}
149
150		// --- Results ------------
151
152		public function getNumber($roundPrecision = 2, $roundMode = PHP_ROUND_HALF_UP)
153		{
154		$value = $this->dividend / $this->divisor;
155
156		if ($roundPrecision >= 0) {
157		$value = round($value, $roundPrecision, $roundMode);
158		}
159
160		return $value;
161		}
162
163		// --- Accessor ------------
164
165		/**
166		* @return mixed
167		*/
168		public function getDividend()
169		{
170		return $this->dividend;
171		}
172
173		/**
174		* @return mixed
175		*/
176		public function getDivisor()
177		{
178		return $this->divisor;
179		}
180
181		// --- Interfaces implementation ------------
182		/**
183		* (PHP 5 >= 5.1.0)<br/>
184		* String representation of object
185		* @link http://php.net/manual/en/serializable.serialize.php
186		* @return string the string representation of the object or null
187		*/
188		public function serialize()
189		{
190		return json_encode(array($this->dividend, $this->divisor));
191		}
192
193		/**
194		* (PHP 5 >= 5.1.0)<br/>
195		* Constructs the object
196		* @link http://php.net/manual/en/serializable.unserialize.php
197		* @param string $serialized <p>
198		* The string representation of the object.
199		* </p>
200		* @return void
201		*/
202		public function unserialize($serialized)
203		{
204		list($this->dividend, $this->divisor) = json_decode($serialized, true);
205		}
206
207		/**
208		* (PHP 5 >= 5.4.0)<br/>
209		* Specify data which should be serialized to JSON
210		* @link http://php.net/manual/en/jsonserializable.jsonserialize.php
211		* @return mixed data which can be serialized by <b>json_encode</b>,
212		* which is a value of any type other than a resource.
213		*/
214		function jsonSerialize()
		0 ignored issues – show Best Practice introduced 2015-12-04 08:07 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
215		{
216		return $this->serialize();
217		}
218
219		}
220

thelia / math-tools

Number::getNumber() A last analyzed 2015-12-04 08:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Number::getNumber() A
last analyzed 2015-12-04 08:13 UTC