djunehor/word-to-number

Transform words to numbers

1.0.0 2019-11-27 22:23 UTC

This package is auto-updated.

Last update: 2019-12-27 23:04:48 UTC


README

CircleCI Latest Stable Version Total Downloads License Build Status Scrutinizer Code Quality Code Coverage StyleCI

This PHP package allows you convert numbers written in words to integers

Installation

You can install the package via composer:

composer require djunehor/word-to-number

Usage

use Djunehor\Number\WordToNumber;

$wordToNumber = new WordToNumber();
$wordTransformer = $wordToNumber->getWordTransformer();
// you can specify locale via: $wordToNumber->getWordTransformer('en');
$number = $wordTransformer->toNumber($word);

Via Helper

$number = word_to_number($word);
//default locale is en

$number = word_to_number($word, 'yo');
// specify Yoruba locale

Available Locales

Language Code Test
English en Yes

Adding New Locale

  • In Locales directory, create YourLocaleTransformer class that implements WordTransformer
  • Ensure there's a toNumber() method that accepts string and returns int
  • Add YourLocaleTransformer::class to $wordTransformers array in WordToNumber
  • Ensure the class pass tests
  • Update the Readme Available Locales section with your newly added locale
  • Create a Pull Request