Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/swashata/php-number-to-word-india

PHP Convert Number to Word in Indian English (Lakh, Crore)
https://github.com/swashata/php-number-to-word-india

convert-numbers crore lakh number-to-words php php-number

Last synced: 2 months ago
JSON representation

PHP Convert Number to Word in Indian English (Lakh, Crore)

Host: GitHub
URL: https://github.com/swashata/php-number-to-word-india
Owner: swashata
License: gpl-3.0
Created: 2017-04-01T06:21:47.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2017-08-09T18:09:14.000Z (over 7 years ago)
Last Synced: 2024-09-21T18:50:46.640Z (4 months ago)
Topics: convert-numbers, crore, lakh, number-to-words, php, php-number
Language: PHP
Homepage:
Size: 64.5 KB
Stars: 12
Watchers: 3
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Number to Words PHP Class - Indian Version

[![Build Status](https://travis-ci.org/swashata/php-number-to-word-india.svg?branch=master)](https://travis-ci.org/swashata/php-number-to-word-india) [![Code Climate](https://codeclimate.com/github/swashata/php-number-to-word-india/badges/gpa.svg)](https://codeclimate.com/github/swashata/php-number-to-word-india) [![Test Coverage](https://codeclimate.com/github/swashata/php-number-to-word-india/badges/coverage.svg)](https://codeclimate.com/github/swashata/php-number-to-word-india/coverage) [![Issue Count](https://codeclimate.com/github/swashata/php-number-to-word-india/badges/issue_count.svg)](https://codeclimate.com/github/swashata/php-number-to-word-india)

This class converts numbers to Indian-English Words. Works for all kinds of
numbers including floats. A few examples.

## Examples

* `10,000,00` - **Ten Lakh**
* `3,478` - **Three Thousand Four Hundred And Seventy Eight**
* `1,234,567,890` - **One Hundred And Twenty Three Crore Forty Five Lakh Sixty Seven Thousand Eight Hundred And Ninty**
* `5,024.78` - **Five Thousand Twenty Four And 78/100**

## Installation

### Using Composer

Navigate to your project directory and execute

`composer require ntwindia/ntwindia`

If you haven't already, include the composer `autoload.php` file.

```php
require_once 'vendor/autoload.php';
```

### Manual Installation

**Clone this repository using git**

```bash
git clone [email protected]:swashata/php-number-to-word-india.git
```

**Include the class**

```php
numToWord( 3104007200 );
// Will print Three Hundred Ten Crore Forty Lakh Seven Thousand Two Hundred
```

If your number is always less than 100, then use `numToWordSmall` method to
reduce memory usage.

```php
numToWordSmall( 99 );
// Will print Ninty Nine
```

## Methods

Two methods are available

### `numToWord`

Converts any number to word including decimal values. Decimals are converted as
`... And 986/1000`. You will mostly need to call this method.

#### Parameters

* `$number`: *integer|float* The number whose word value would be generated.

#### Return

Returns `string` The word value of the number. All of the words have uppercased
first letter.

### `numToWordSmall`

Converts numbers smaller than 100 into words. If the number is greater than 99
then it simply calls `numToWord`.

Use this when you know your number is lesser than 100 to reduce memory usage.

#### Parameters

* `$number`: *integer* The number whose word value would be generated. It does
not accepts floating values and will convert to integer if given.

#### Return

Returns `string` The word value of the number. All of the words have uppercased
first letter.

## Exception Handling

Two exceptions are thrown depending on the condition.

### `\NTWIndia\Exception\NTWIndiaInvalidNumber`

If you pass a variable to a method which isn't a valid number `( ! is_numeric( $number ) )`

### `\NTWIndia\Exception\NTWIndiaNumberOverflow`

If pass a number which exceeds the limit.

* For `numToWord` it is the `PHP_MAX_INT`.
* For `numToWordSmall` it is `99`.

## Translation

To translate, kindly replace the public variables:

* `$hundred`: Hundred word. Defaults *'Hundred'*.
* `$thousand`: Thousand word. Defaults *'Thousand'*.
* `$lakh`: Lakh word. Defaults *'Lakh'*.
* `$crore`: Crore word. Defaults *'Crore'*.
* `$and`: And word. Defaults *'And'*.
* `$numToWord`: Contains mapping of numbers to words. From `0` to `20` and multiple
of `10` upto `90`.

## Unit Test

Unit test is available through composer.

```bash
$ cd /path/to/php-number-to-word-india/
$ composer update
$ vendor/bin/phpunit
```

It will output something like this.

![Test Case](test-case.png)

You are more than welcome to add more test cases and send me a pull request.

Kindly follow [Contribution Guide](CONTRIBUTING.md)

## License

PHP Number to Word in Indian Style is licensed under GPLv3

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see