Logic Money->format( $format = null ) and Money->format_i18n( $format = null ) confusing?

[remcotolsma]

In both functions the $format parameter is optional, but the parameter doesn't work the same way. If null is passed in Money->format_i18n( $format = null ) function it will fall back to Money::get_default_format():

wp-money/src/Money.php

Lines 71 to 73 in 86b41ad

	if ( is_null( $format ) ) {
	$format = self::get_default_format();
	}

If null is passed in Money->format( $format = null ) function it will fall back to '%2$s':

wp-money/src/Money.php

Lines 127 to 129 in 86b41ad

	if ( is_null( $format ) ) {
	$format = '%2$s';
	}

Currently it's very imported that Money->format( $format = null ) falls back to '%2$s', otherwise some of the gateways will break:

pronamic/wp-pronamic-pay-mollie@08bc30c

However, it is not very logical that the Money->format( $format = null ) does not process currency information by default, without currency information it's just a number.

We could make this more clear like this: Money->format_amount( $number_decimals = null );, if $number_decimals is null we can fall back to the currency $number_decimals value, similarly an i18n version: $money->format_i18n_amount( $number_decimals );.

Naming can also be different:

• Money->number_format( $number_decimals = null )
• Money->amount_format( $number_decimals = null )
• Money->number_format_i18n( $number_decimals = null )
• Money->amount_format_i18n( $number_decimals = null )

I think i prefer number_format and number_format_i18n:

• https://www.php.net/number_format
• https://developer.wordpress.org/reference/functions/number_format_i18n/

The default format for Money->format( $format = null ) can then be changed to '%3$s%2$s' so that it contains at least the currency code by default.

Maybe we should also consider replacing the printf directives with placeholders:

$placeholders = array(
	'{non_breaking_space}'            => ...,
	'{currency_symbol}'               => ...,
	'{currency_alphabetic_code}'      => ...,
	'{currency_numeric_code}'         => ...,
	'{currency_name}'                 => ...,
	'{amount}'                        => ...,
	'{amount_i18n}'                   => ...,
	'{amount_no_trailing_zeros}'      => ...,
	'{amount_i18n_no_trailing_zeros}' => ...,
);

Current use is not very clear:

echo $money->format( '%3$s%2$s' );

You have no idea what the result is, following is more clear:

echo $money->format( '{currency_alphabetic_code}{non_breaking_space}{amount}' );

• https://www.php.net/manual/en/class.numberformatter.php
• https://www.php.net/money_format

@rvdsteege thoughts?

[rvdsteege]

New methods added by @remcotolsma in a08b3f8:

• Money->number_format( $decimals, $decimal_separator, $thousands_separator )
• Money->number_format_i18n( $decimals )