TripletTransformer - Code Metrics - Inspection of "Thêm hàm transformer và autoload hàm đó" - phpviet/number-to-words - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

unknown

created 2020-07-05 08:43 UTC

TripletTransformer A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	76
rs	10
c	0
b	0
f	0
wmc	14
lcom	1
cbo	0

3 Methods

Rating	Name	Size	Complexity
B	tripletToWords()	24	7
A	splitTriplet()	8	1
A	getTripletUnit()	18	6

<?php
/**
 * @link https://github.com/phpviet/number-to-words
 * @copyright (c) PHP Viet
 * @license [MIT](http://www.opensource.org/licenses/MIT)
 */

namespace PHPViet\NumberToWords\Concerns;

/**
 * @author Vuong Minh <[email protected]>
 * @since 1.0.0
 */
trait TripletTransformer
{
    /**
     * Chuyển đổi cụm 3 số thành chữ số.
     *
     * @param  int  $triplet
     * @param  bool  $isFirst
     * @param  int  $exponent
     * @return string
     */
    protected function tripletToWords(int $triplet, bool $isFirst, int $exponent): string
    {
        [$hundred, $ten, $unit] = $this->splitTriplet($triplet);


        if (0 < $hundred || ! $isFirst) {
            $words[] = $this->dictionary->getTripletHundred($hundred);
class MyClass { }

$x = new MyClass();
$x->foo = true;

            if (0 === $ten && 0 < $unit) {
                $words[] = $this->dictionary->tripletTenSeparator();
            }
        }

        if (0 < $ten) {
            $words[] = $this->dictionary->getTripletTen($ten);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }

        if (0 < $unit) {
            $words[] = $this->getTripletUnit($unit, $ten);
        }

        $words[] = $this->dictionary->getExponent($exponent);

        return $this->collapseWords($words);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Chia 3 số thành mảng 3 phần tử tương ứng với hàng trăm, hàng chục, hàng đơn vị.
     *
     * @param  int  $triplet
     * @return array
     */
    private function splitTriplet(int $triplet): array
    {
        $hundred = (int) ($triplet / 100) % 10;
        $ten = (int) ($triplet / 10) % 10;
        $unit = $triplet % 10;

        return [$hundred, $ten, $unit];
    }

    /**
     * Chuyển đổi số hàng đơn vị sang chữ số ở một số trường hợp đặc biệt.
     *
     * @param  int  $unit
     * @param  int  $ten
     * @return null|string
     */
    private function getTripletUnit(int $unit, int $ten): string
    {
        if (1 <= $ten && 5 === $unit) {
            return $this->dictionary->specialTripletUnitFive();
        }

        if (2 <= $ten) {
            if (1 === $unit) {
                return $this->dictionary->specialTripletUnitOne();
            }

            if (4 === $unit) {
                return $this->dictionary->specialTripletUnitFour();
            }
        }

        return $this->dictionary->getTripletUnit($unit);
    }
}


1			<?php
2			/**
3			* @link https://github.com/phpviet/number-to-words
4			* @copyright (c) PHP Viet
5			* @license [MIT](http://www.opensource.org/licenses/MIT)
6			*/
7
8			namespace PHPViet\NumberToWords\Concerns;
9
10			/**
11			* @author Vuong Minh <[email protected]>
12			* @since 1.0.0
13			*/
14			trait TripletTransformer
15			{
16			/**
17			* Chuyển đổi cụm 3 số thành chữ số.
18			*
19			* @param int $triplet
20			* @param bool $isFirst
21			* @param int $exponent
22			* @return string
23			*/
24			protected function tripletToWords(int $triplet, bool $isFirst, int $exponent): string
25			{
26			[$hundred, $ten, $unit] = $this->splitTriplet($triplet);
			0 ignored issues – show Bug introduced 2019-06-05 00:23 UTC by Report Bug Copy Issue Report The variable `$hundred` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-06-05 00:23 UTC by Report Bug Copy Issue Report The variable `$ten` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-06-05 00:23 UTC by Report Bug Copy Issue Report The variable `$unit` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
27
28			if (0 < $hundred \|\| ! $isFirst) {
29			$words[] = $this->dictionary->getTripletHundred($hundred);
			0 ignored issues – show Bug introduced 2020-07-05 08:52 UTC by Report Bug Copy Issue Report The property `dictionary` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Coding Style Comprehensibility introduced 2020-07-05 08:52 UTC by Report Bug Copy Issue Report `$words` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$words = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
30
31			if (0 === $ten && 0 < $unit) {
32			$words[] = $this->dictionary->tripletTenSeparator();
33			}
34			}
35
36			if (0 < $ten) {
37			$words[] = $this->dictionary->getTripletTen($ten);
			0 ignored issues – show Bug introduced 2020-07-05 08:52 UTC by Report Bug Copy Issue Report The variable `$words` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
38			}
39
40			if (0 < $unit) {
41			$words[] = $this->getTripletUnit($unit, $ten);
42			}
43
44			$words[] = $this->dictionary->getExponent($exponent);
45
46			return $this->collapseWords($words);
			0 ignored issues – show Bug introduced 2020-07-05 08:52 UTC by Report Bug Copy Issue Report It seems like `collapseWords()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
47			}
48
49			/**
50			* Chia 3 số thành mảng 3 phần tử tương ứng với hàng trăm, hàng chục, hàng đơn vị.
51			*
52			* @param int $triplet
53			* @return array
54			*/
55			private function splitTriplet(int $triplet): array
56			{
57			$hundred = (int) ($triplet / 100) % 10;
58			$ten = (int) ($triplet / 10) % 10;
59			$unit = $triplet % 10;
60
61			return [$hundred, $ten, $unit];
62			}
63
64			/**
65			* Chuyển đổi số hàng đơn vị sang chữ số ở một số trường hợp đặc biệt.
66			*
67			* @param int $unit
68			* @param int $ten
69			* @return null\|string
70			*/
71			private function getTripletUnit(int $unit, int $ten): string
72			{
73			if (1 <= $ten && 5 === $unit) {
74			return $this->dictionary->specialTripletUnitFive();
75			}
76
77			if (2 <= $ten) {
78			if (1 === $unit) {
79			return $this->dictionary->specialTripletUnitOne();
80			}
81
82			if (4 === $unit) {
83			return $this->dictionary->specialTripletUnitFour();
84			}
85			}
86
87			return $this->dictionary->getTripletUnit($unit);
88			}
89			}
90

phpviet / number-to-words

Pull Request — master (#4)

TripletTransformer A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like