riskihajar/terbilang

Number to words conversion support multi language.

2.0.8 2024-03-31 03:08 UTC

Requires

• php: ^7.4|^8.0|^8.1|^8.2
• illuminate/contracts: ^8.0|^9.0|^10.0|^11.0
• spatie/laravel-package-tools: ^1.0

Requires (Dev)

• larastan/larastan: ^1.0|^2.0
• laravel/pint: ^1.0
• nunomaduro/collision: ^5.0|^6.0|^7.0|^8.0
• orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
• pestphp/pest: ^1.21|^2.0
• pestphp/pest-plugin-laravel: ^1.1|^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.0|^10.0|^11.0

MIT

• Rizky Hajar

• laravel
• terbilang
• number to words
• date to words
• number to roman
• riskihajar

README

Number to words conversion support multi language.

Warning

Before you install this package, please check Laravel Numbers Helper, since laravel officially support numbers helper, maybe this package will deprecated soon.

Supported Language

• id | Bahasa Indonesia
• en | English
• pt | Portuguese
• soon

Feature

• Number to Words
• Number to Roman
• Number Large Conversion (Number Short Hand in past version)
• Datetime to Words
• Distance Date (Period in past version)

Version Compatibility

Installation

You can install the package via composer:

composer require riskihajar/terbilang:^2.0

Usage

Add Providers & Aliases

In the $providers array add the service providers for this package.

Riskihajar\Terbilang\TerbilangServiceProvider::class,

Add the facade of this package to the $aliases array.

'Terbilang' => Riskihajar\Terbilang\Facades\Terbilang::class,

Publish Configuration (Optional)

If you want customize configuration, you can run following command to publish config file

php artisan vendor:publish --provider="Riskihajar\Terbilang\TerbilangServiceProvider"

This is the contents of the published config file:

return [
    'output' => [
        'date' => '{DAY} {MONTH} {YEAR}',
        'time' => '{HOUR} {SEPARATOR} {MINUTE} {MINUTE_LABEL} {SECOND} {SECOND_LABEL}',
    ],

    'locale' => 'en',

    'distance' => [
        'type' => \Riskihajar\Terbilang\Enums\DistanceDate::Day,
        'template' => '{YEAR} {MONTH} {DAY} {HOUR} {MINUTE} {SECOND}',
        'hide_zero_value' => true,
        'separator' => ' ',
        'terbilang' => false,
        'show' => [
            'year' => true,
            'month' => true,
            'day' => true,
            'hour' => true,
            'minute' => true,
            'second' => true,
        ],
    ],
];

Examples

Number To Words

Terbilang::make($number, $suffix, $prefix)

if you set locale to en

Config::set('terbilang.locale', 'en');

Terbilang::make(1000000); // one million

if you set locale to id

Config::set('terbilang.locale', 'id');

Terbilang::make(1000000); // satu juta

Prefix & Suffix

if you set locale to id

Terbilang::make(123456, ' rupiah', 'senilai ');
// senilai seratus dua puluh tiga ribu, empat ratus lima puluh enam rupiah

if you set locale to en

Terbilang::make(654321, ' dollars');
// six hundred and fifty-four thousand, three hundred and twenty-one dollars

Number to Roman

Terbilang::roman($number, $lowercase=false)

Terbilang::roman(1234); // MCCXXXIV

Number Large Conversion

Terbilang::short($number, $format)

Available short hand : kilo, million, billion, trillion

Default value : million

if you set locale to en

Terbilang::short(1000000); // 1M

if you set locale to id

Terbilang::short(1000000); // 1jt

Datetime

Date Terbilang::date($date, $format='Y-m-d');

$date = date('Y-m-d'); // 2015-03-31
Terbilang::date($date);
// Result : tiga puluh satu maret dua ribu lima belas

Time Terbilang::time($date, $format='h:i:s');

$date = date('h:i:s'); //10:56:30
Terbilang::time($date);
// Result : sepuluh lewat lima puluh enam menit tiga puluh tiga detik

Date Time Terbilang::datetime($date, $format='Y-m-d h:i:s');

$date = date('Y-m-d h:i:s'); // 2015-03-31 10:58:27
Terbilang::datetime($date);
// Result : tiga puluh satu maret dua ribu lima belas pukul sepuluh lewat lima puluh delapan menit dua puluh tujuh detik

Using Carbon

if using carbon, you can ignore $format

$dt = Carbon\Carbon::now('Asia/Makassar');

$date = Terbilang::date($dt);
$time = Terbilang::time($dt);
$datetime = Terbilang::datetime($dt);

Distance Date

You can diff two dates or just one date and automaticly with current date use method Terbilang::distance($start, $end=null, $format=null)

Config for distance format

'distance' => [
     'type' => 'FULL',
     'format' => '{YEAR} {MONTH} {DAY} {HOUR} {MINUTE} {SECOND}',
     'hide_zero_value' => true,
     'separator' => ' ',
     'terbilang' => false,
     'show' => [
         'year' => true,
         'month' => true,
         'day' => true,
         'hour' => true,
         'minute' => true,
         'second' => true,
     ]
 ],

Example Distance

$date1 = date('Y-m-d', strtotime('2017-05-01')); // dateformat must Y-m-d H:i:s
$date2 = date('Y-m-d', strtotime('2017-06-15 09:30:15'));

// this method will diff $date1 with current datetime value for example current datetime : 2017-09-08 15:17:54
Terbilang::period($date1); // Result : 4 months 8 days 15 hours 17 minutes 54 seconds

Terbilang::period($date1, $date2); // Result : 1 months 15 days 9 hours 30 minutes 15 seconds

// if you set locale to id
Terbilang::period($date1, $date2); // Result : 1 bulan 15 hari 9 jam 30 menit 15 detik

// if you set config period.terbilang to true
Terbilang::period($date1, $date2); // Result : satu bulan lima belas hari sembilan jam tiga puluh menit lima belas detik

// if you set config period.type to DAY
Terbilang::period($date1, $date2); // Result : 45 hari

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Rizky Hajar
• All Contributors

License

The MIT License (MIT). Please see License File for more information.