Mailcode_Number_LocalCurrency::getRegion() - Code Metrics - Inspection of "introducing showprice command" - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

unknown

created 2024-10-21 17:29 UTC

Mailcode_Number_LocalCurrency::getRegion() A

↳ Parent: Mailcode_Number_LocalCurrency

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace Mailcode;

use AppUtils\OperationResult;

class Mailcode_Number_LocalCurrency extends OperationResult
{
    public const DEFAULT_COUNTRY = "US";
    public const DEFAULT_CURRENCY_NAME = "USD";
    public const DEFAULT_CURRENCY_SYMBOL = "$";
    public const DEFAULT_UNIT_SEPARATOR = " ";
    public const DEFAULT_FORMAT = "1,000.00";

    private string $country;
    private string $currencyName;
    private string $currencySymbol;
    private string $unitSeparator;
    private string $formatString;

    private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $currency = null;
    private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $region = null;

    private static ?Mailcode_Number_LocalCurrency $instance = null;

    /**
     * @param string $country
     * @param string $currencyName
     * @param string $currencySymbol
     * @param string $unitSeparator
     * @param string $formatString
     * @param ?Mailcode_Parser_Statement_Tokenizer_Token $currency
     * @param ?Mailcode_Parser_Statement_Tokenizer_Token $region
     */
    public function __construct(string                                     $country,
                                string                                     $currencyName,
                                string                                     $currencySymbol,
                                string                                     $unitSeparator,
                                string                                     $formatString,
                                ?Mailcode_Parser_Statement_Tokenizer_Token $currency = null,
                                ?Mailcode_Parser_Statement_Tokenizer_Token $region = null)
    {
        $this->country = $country;
        $this->currencyName = $currencyName;
        $this->currencySymbol = $currencySymbol;
        $this->unitSeparator = $unitSeparator;
        $this->formatString = $formatString;

        $this->currency = $currency;
        $this->region = $region;
    }

    public function getCountry(): string
    {
        return $this->country;
    }

    public function getCurrencyName(): string
    {
        return $this->currencyName;
    }

    public function getCurrencySymbol(): string
    {
        return $this->currencySymbol;
    }

    public function getUnitSeparator(): string
    {
        return $this->unitSeparator;
    }

    public function getFormatString(): string
    {
        return $this->formatString;
    }

    public function getRegion(): ?Mailcode_Parser_Statement_Tokenizer_Token
    {
        return $this->region;
    }

    public function getCurrency(): ?Mailcode_Parser_Statement_Tokenizer_Token
    {
        return $this->currency;
    }

    public function withRegion(?Mailcode_Parser_Statement_Tokenizer_Token $region = null): Mailcode_Number_LocalCurrency
    {
        return new Mailcode_Number_LocalCurrency(
            $this->country,
            $this->currencyName,
            $this->currencySymbol,
            $this->unitSeparator,
            $this->formatString,
            $this->currency,
            $region
        );
    }

    public function withCurrency(?Mailcode_Parser_Statement_Tokenizer_Token $currency = null): Mailcode_Number_LocalCurrency
    {
        return new Mailcode_Number_LocalCurrency(
            $this->country,
            $this->currencyName,
            $this->currencySymbol,
            $this->unitSeparator,
            $this->formatString,
            $currency,
            $this->region
        );
    }

    public function getFormatInfo(): Mailcode_Number_Info
    {
        return new Mailcode_Number_Info($this->formatString);
    }

    public static function defaultInstance(): Mailcode_Number_LocalCurrency
    {
        if (!isset(self::$instance)) {
            self::$instance = new self(
                self::DEFAULT_COUNTRY,
                self::DEFAULT_CURRENCY_NAME,
                self::DEFAULT_CURRENCY_SYMBOL,
                self::DEFAULT_UNIT_SEPARATOR,
                self::DEFAULT_FORMAT
            );
        }
        return self::$instance;

    }
}

1			<?php
2
3			declare(strict_types=1);
4
5			namespace Mailcode;
6
7			use AppUtils\OperationResult;
8
9			class Mailcode_Number_LocalCurrency extends OperationResult
10			{
11			public const DEFAULT_COUNTRY = "US";
12			public const DEFAULT_CURRENCY_NAME = "USD";
13			public const DEFAULT_CURRENCY_SYMBOL = "$";
14			public const DEFAULT_UNIT_SEPARATOR = " ";
15			public const DEFAULT_FORMAT = "1,000.00";
16
17			private string $country;
18			private string $currencyName;
19			private string $currencySymbol;
20			private string $unitSeparator;
21			private string $formatString;
22
23			private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $currency = null;
24			private ?Mailcode_Parser_Statement_Tokenizer_Token_Variable $region = null;
25
26			private static ?Mailcode_Number_LocalCurrency $instance = null;
27
28			/**
29			* @param string $country
30			* @param string $currencyName
31			* @param string $currencySymbol
32			* @param string $unitSeparator
33			* @param string $formatString
34			* @param ?Mailcode_Parser_Statement_Tokenizer_Token $currency
35			* @param ?Mailcode_Parser_Statement_Tokenizer_Token $region
36			*/
37			public function __construct(string $country,
38			string $currencyName,
39			string $currencySymbol,
40			string $unitSeparator,
41			string $formatString,
42			?Mailcode_Parser_Statement_Tokenizer_Token $currency = null,
43			?Mailcode_Parser_Statement_Tokenizer_Token $region = null)
44			{
45			$this->country = $country;
46			$this->currencyName = $currencyName;
47			$this->currencySymbol = $currencySymbol;
48			$this->unitSeparator = $unitSeparator;
49			$this->formatString = $formatString;
50
51			$this->currency = $currency;
52			$this->region = $region;
53			}
54
55			public function getCountry(): string
56			{
57			return $this->country;
58			}
59
60			public function getCurrencyName(): string
61			{
62			return $this->currencyName;
63			}
64
65			public function getCurrencySymbol(): string
66			{
67			return $this->currencySymbol;
68			}
69
70			public function getUnitSeparator(): string
71			{
72			return $this->unitSeparator;
73			}
74
75			public function getFormatString(): string
76			{
77			return $this->formatString;
78			}
79
80			public function getRegion(): ?Mailcode_Parser_Statement_Tokenizer_Token
81			{
82			return $this->region;
83			}
84
85			public function getCurrency(): ?Mailcode_Parser_Statement_Tokenizer_Token
86			{
87			return $this->currency;
88			}
89
90			public function withRegion(?Mailcode_Parser_Statement_Tokenizer_Token $region = null): Mailcode_Number_LocalCurrency
91			{
92			return new Mailcode_Number_LocalCurrency(
93			$this->country,
94			$this->currencyName,
95			$this->currencySymbol,
96			$this->unitSeparator,
97			$this->formatString,
98			$this->currency,
99			$region
100			);
101			}
102
103			public function withCurrency(?Mailcode_Parser_Statement_Tokenizer_Token $currency = null): Mailcode_Number_LocalCurrency
104			{
105			return new Mailcode_Number_LocalCurrency(
106			$this->country,
107			$this->currencyName,
108			$this->currencySymbol,
109			$this->unitSeparator,
110			$this->formatString,
111			$currency,
112			$this->region
113			);
114			}
115
116			public function getFormatInfo(): Mailcode_Number_Info
117			{
118			return new Mailcode_Number_Info($this->formatString);
119			}
120
121			public static function defaultInstance(): Mailcode_Number_LocalCurrency
122			{
123			if (!isset(self::$instance)) {
124			self::$instance = new self(
125			self::DEFAULT_COUNTRY,
126			self::DEFAULT_CURRENCY_NAME,
127			self::DEFAULT_CURRENCY_SYMBOL,
128			self::DEFAULT_UNIT_SEPARATOR,
129			self::DEFAULT_FORMAT
130			);
131			}
132			return self::$instance;
			0 ignored issues – show Bug Best Practice introduced 2024-08-20 08:31 UTC by Report Bug Copy Issue Report The expression `return self::instance` could return the type `null` which is incompatible with the type-hinted return `Mailcode\Mailcode_Number_LocalCurrency`. Consider adding an additional type-check to rule them out. Loading history...
133			}
134			}

Mistralys / mailcode

Pull Request — master (#18)

Mailcode_Number_LocalCurrency::getRegion() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like