Sfneal\Currency\Currency

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	euros()	0	3	1
A	pounds()	0	3	1
A	dollars()	0	3	1
A	format()	0	20	3

<?php

namespace Sfneal\Currency;

class Currency
{
    /**
     * Currency Symbols.
     */
    public const USD = '$';
    public const EUR = '€';
    public const GBP = '£';
    public const INR = '₹';
    public const JPY = '¥';
    public const CNY = '¥';
    public const THB = '฿';
    public const AUD = self::USD;
    public const CAD = self::USD;
    public const NZD = self::USD;

    /**
     * Format a currency float value to a standard format.
     *
     * @param float $amount
     * @param string|null $currency
     * @param bool $commaSeparated
     * @param int $decimals
     * @return string
     */
    public static function format(float $amount,
                                  string $currency = null,
                                  bool $commaSeparated = false,
                                  int $decimals = 2): string
    {
        // Format the current amount
        $value = number_format(
            $amount,
            $decimals,
            '.',
            $commaSeparated ? ',' : ''
        );

        // Prepend currency symbol
        if ($currency) {
            return $currency.$value;
        }

        // Value without currency symbol
        return $value;
    }

    /**
     * Format a USD float value to a standard format.
     *
     * @param float $amount
     * @param bool $commaSeparated
     * @param int $decimals
     * @return string
     */
    public static function dollars(float $amount, bool $commaSeparated = false, int $decimals = 2): string
    {
        return self::format($amount, self::USD, $commaSeparated, $decimals);
    }

    /**
     * Format a EUR float value to a standard format.
     *
     * @param float $amount
     * @param bool $commaSeparated
     * @param int $decimals
     * @return string
     */
    public static function euros(float $amount, bool $commaSeparated = false, int $decimals = 2): string
    {
        return self::format($amount, self::EUR, $commaSeparated, $decimals);
    }

    /**
     * Format a GBP float value to a standard format.
     *
     * @param float $amount
     * @param bool $commaSeparated
     * @param int $decimals
     * @return string
     */
    public static function pounds(float $amount, bool $commaSeparated = false, int $decimals = 2): string
    {
        return self::format($amount, self::GBP, $commaSeparated, $decimals);
    }
}