Money::get_minor_units() - Code Metrics - Inspection of "Update Travis PHP version from 7.2 to 7.3." - pronamic/wp-money - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — develop ( 63d4ce...c4a746 )

by Reüel

created 2019-03-07 12:54 UTC

Money::get_minor_units() A

↳ Parent: Money

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	4
nop	0
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0

<?php
/**
 * Money
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2019 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Money
 */

namespace Pronamic\WordPress\Money;

/**
 * Money
 *
 * @author Remco Tolsma
 * @version 1.2.0
 * @since   1.0.0
 */
class Money {
	/**
	 * Amount value.
	 *
	 * @var float
	 */
	private $value;

	/**
	 * Currency.
	 *
	 * @var Currency
	 */
	private $currency;

	/**
	 * Construct and initialize money object.
	 *
	 * @param string|int|float     $value    Amount value.
	 * @param Currency|string|null $currency Currency.
	 */
	public function __construct( $value = 0, $currency = null ) {
		$this->set_value( $value );
		$this->set_currency( $currency );

	}

	/**
	 * Get default format.
	 *
	 * @return string
	 */
	public static function get_default_format() {
		/* translators: 1: currency symbol, 2: amount value, 3: currency code, note: use non-breaking space! */
		$format = _x( '%1$s%2$s %3$s', 'money format', 'pronamic-money' );
		// Note:               ↳ Non-breaking space.
		$format = apply_filters( 'pronamic_money_default_format', $format );

		return $format;
	}

	/**
	 * Format i18n.
	 *
	 * @param string|null $format Format.
	 *
	 * @return string
	 */
	public function format_i18n( $format = null ) {
		if ( is_null( $format ) ) {
			$format = self::get_default_format();
		}

		if ( isset( $this->currency ) ) {
			return sprintf(
				$format,
				$this->currency->get_symbol(),
				number_format_i18n( $this->get_value(), $this->currency->get_number_decimals() ),
				$this->currency->get_alphabetic_code()
			);
		}

		return number_format_i18n( $this->get_value(), 2 );
	}

	/**
	 * Get value.
	 *
	 * @return float Amount value.
	 */
	public function get_value() {
		return $this->value;
	}

	/**
	 * Get amount.
	 *
	 * @deprecated 1.2.0
	 * @return float Amount value.
	 */
	public function get_amount() {
		_deprecated_function( __METHOD__, '1.2.0', 'Money::get_value()' );

		return $this->get_value();
	}

	/**
	 * Get cents.
	 *
	 * @return float
	 */
	public function get_cents() {
		return $this->value * 100;
	}

	/**
	 * Get amount in minor units.
	 *
	 * Examples for value 10:
	 *   JPY 0 decimals: 10
	 *   EUR 2 decimals: 1000
	 *   BHD 3 decimals: 10000
	 *   NLG 4 decimals: 100000
	 *
	 * @return int
	 */
	public function get_minor_units() {
		// Use 2 decimals by default (most common).
		$decimals = 2;

		// Get number of decimals from currency if available.
		if ( $this->get_currency() ) {
			$decimals = $this->currency->get_number_decimals();
		}

		// Return amount in minor units.
		if ( function_exists( 'bcmul' ) ) {
			$minor_units = bcmul( $this->value, pow( 10, $decimals ), 0 );
		} else {
			$minor_units = $this->value * pow( 10, $decimals );
		}

		return (int) (string) $minor_units;
	}

	/**
	 * Set value.
	 *
	 * @param mixed $value Amount value.
	 */
	public function set_value( $value ) {
		$this->value = floatval( $value );
	}

	/**
	 * Set amount.
	 *
	 * @deprecated 1.2.0
	 * @param mixed $value Amount value.
	 */
	public function set_amount( $value ) {
		_deprecated_function( __METHOD__, '1.2.0', 'Money::set_value()' );

		$this->set_value( $value );
	}

	/**
	 * Get currency.
	 *
	 * @return Currency
	 */
	public function get_currency() {
		return $this->currency;
	}

	/**
	 * Set currency.
	 *
	 * @param string $currency Currency.
	 */
	public function set_currency( $currency ) {
		if ( is_object( $currency ) && is_a( $currency, __NAMESPACE__ . '\Currency' ) ) {
			$this->currency = $currency;

			return;
		}

		$this->currency = Currency::get_instance( $currency );
	}

	/**
	 * Create a string representation of this money object.
	 *
	 * @return string
	 */
	public function __toString() {
		return $this->format_i18n();
	}
}


1			<?php
2			/**
3			* Money
4			*
5			* @author Pronamic <[email protected]>
6			* @copyright 2005-2019 Pronamic
7			* @license GPL-3.0-or-later
8			* @package Pronamic\WordPress\Money
9			*/
10
11			namespace Pronamic\WordPress\Money;
12
13			/**
14			* Money
15			*
16			* @author Remco Tolsma
17			* @version 1.2.0
18			* @since 1.0.0
19			*/
20			class Money {
21			/**
22			* Amount value.
23			*
24			* @var float
25			*/
26			private $value;
27
28			/**
29			* Currency.
30			*
31			* @var Currency
32			*/
33			private $currency;
34
35			/**
36			* Construct and initialize money object.
37			*
38			* @param string\|int\|float $value Amount value.
39			* @param Currency\|string\|null $currency Currency.
40			*/
41			public function __construct( $value = 0, $currency = null ) {
42			$this->set_value( $value );
43			$this->set_currency( $currency );
			0 ignored issues – show Bug introduced 2018-04-19 18:54 UTC by Report Bug Copy Issue Report It seems like `$currency` defined by parameter `$currency` on line 41 can also be of type `null` or `object<Pronamic\WordPress\Money\Currency>`; however, `Pronamic\WordPress\Money\Money::set_currency()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
44			}
45
46			/**
47			* Get default format.
48			*
49			* @return string
50			*/
51			public static function get_default_format() {
52			/* translators: 1: currency symbol, 2: amount value, 3: currency code, note: use non-breaking space! */
53			$format = _x( '%1$s%2$s %3$s', 'money format', 'pronamic-money' );
54			// Note: ↳ Non-breaking space.
55			$format = apply_filters( 'pronamic_money_default_format', $format );
56
57			return $format;
58			}
59
60			/**
61			* Format i18n.
62			*
63			* @param string\|null $format Format.
64			*
65			* @return string
66			*/
67			public function format_i18n( $format = null ) {
68			if ( is_null( $format ) ) {
69			$format = self::get_default_format();
70			}
71
72			if ( isset( $this->currency ) ) {
73			return sprintf(
74			$format,
75			$this->currency->get_symbol(),
76			number_format_i18n( $this->get_value(), $this->currency->get_number_decimals() ),
77			$this->currency->get_alphabetic_code()
78			);
79			}
80
81			return number_format_i18n( $this->get_value(), 2 );
82			}
83
84			/**
85			* Get value.
86			*
87			* @return float Amount value.
88			*/
89			public function get_value() {
90			return $this->value;
91			}
92
93			/**
94			* Get amount.
95			*
96			* @deprecated 1.2.0
97			* @return float Amount value.
98			*/
99			public function get_amount() {
100			_deprecated_function( __METHOD__, '1.2.0', 'Money::get_value()' );
101
102			return $this->get_value();
103			}
104
105			/**
106			* Get cents.
107			*
108			* @return float
109			*/
110			public function get_cents() {
111			return $this->value * 100;
112			}
113
114			/**
115			* Get amount in minor units.
116			*
117			* Examples for value 10:
118			* JPY 0 decimals: 10
119			* EUR 2 decimals: 1000
120			* BHD 3 decimals: 10000
121			* NLG 4 decimals: 100000
122			*
123			* @return int
124			*/
125			public function get_minor_units() {
126			// Use 2 decimals by default (most common).
127			$decimals = 2;
128
129			// Get number of decimals from currency if available.
130			if ( $this->get_currency() ) {
131			$decimals = $this->currency->get_number_decimals();
132			}
133
134			// Return amount in minor units.
135			if ( function_exists( 'bcmul' ) ) {
136			$minor_units = bcmul( $this->value, pow( 10, $decimals ), 0 );
137			} else {
138			$minor_units = $this->value * pow( 10, $decimals );
139			}
140
141			return (int) (string) $minor_units;
142			}
143
144			/**
145			* Set value.
146			*
147			* @param mixed $value Amount value.
148			*/
149			public function set_value( $value ) {
150			$this->value = floatval( $value );
151			}
152
153			/**
154			* Set amount.
155			*
156			* @deprecated 1.2.0
157			* @param mixed $value Amount value.
158			*/
159			public function set_amount( $value ) {
160			_deprecated_function( __METHOD__, '1.2.0', 'Money::set_value()' );
161
162			$this->set_value( $value );
163			}
164
165			/**
166			* Get currency.
167			*
168			* @return Currency
169			*/
170			public function get_currency() {
171			return $this->currency;
172			}
173
174			/**
175			* Set currency.
176			*
177			* @param string $currency Currency.
178			*/
179			public function set_currency( $currency ) {
180			if ( is_object( $currency ) && is_a( $currency, __NAMESPACE__ . '\Currency' ) ) {
181			$this->currency = $currency;
182
183			return;
184			}
185
186			$this->currency = Currency::get_instance( $currency );
187			}
188
189			/**
190			* Create a string representation of this money object.
191			*
192			* @return string
193			*/
194			public function __toString() {
195			return $this->format_i18n();
196			}
197			}
198

pronamic / wp-money

Push — develop ( 63d4ce...c4a746 )

Money::get_minor_units() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like