yii2-money

Note

This extension has been replaced with the yii2-number extension since Jan 2018. This extension will not be enhanced further or supported. Recommend to head over to yii2-number extension docs and demos for enhanced number management functionality for Yii2.

An advanced money mask input for Yii Framework 2 based on jQuery-maskMoney plugin. The plugin offers a simple way to create masks to your currency form fields. The yii2-money extension includes these additional enhancements in order to use the maskMoney plugin effectively:

• default styling for Bootstrap 3 and supports Yii Active Field validations
• automatically read a float/decimal and convert it to the money format on field load
• automatically convert back the field to a float/decimal for saving once the mask is changed (maintains an internal hidden field)
• allows global settings of the mask money plugin options via Yii::$app->params

Demo

You can see detailed documentation on usage of the extension.

Latest Release

The latest version of the extension is release v1.2.2. Refer the CHANGE LOG for details of various releases.

Installation

The preferred way to install this extension is through composer.

Note: Check the composer.json for this extension's requirements and dependencies. Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json.

Either run

$ php composer.phar require kartik-v/yii2-money "dev-master"

or add

"kartik-v/yii2-money": "dev-master"

to the require section of your composer.json file.

Usage

Global Settings

You can globally set the plugin options for your money format across the application in the params section of your Yii configuration file. You need to set the maskMoneyOptions in your Yii application params. For example:

'params' => [
    'maskMoneyOptions' => [
        'prefix' => 'US$ ',
        'suffix' => ' c',
        'affixesStay' => true,
        'thousands' => ',',
        'decimal' => '.',
        'precision' => 2, 
        'allowZero' => false,
        'allowNegative' => false,
    ]
]

Formatter Settings

If you have not setup params like above, the plugin will default the thousandSeparator and decimalSeparator from Yii::$app->formatter settings in your configuration file.

'components' => [
    'formatter' => [
        'class' => 'yii\i18n\formatter',
        'thousandSeparator' => ',',
        'decimalSeparator' => '.',
    ]
]

MaskMoney

You can configure the widget as shown below. Any plugin option not passed, will be defaulted from the above two sections (params and formatter). Note that properties directly set in pluginOptions at the widget level as shown below, will override other global settings.

use kartik\money\MaskMoney;
echo MaskMoney::widget([
    'name' => 'currency',
    'value' => 122423.18,
    'pluginOptions' => [
        'prefix' => '$ ',
    ],
]); 

License

yii2-money is released under the BSD 3-Clause License. See the bundled LICENSE.md for details.