Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cs-eliseev/helpers-word
The helpers allows you to modify string data. Inclination, transliterate, convert month date and convert number or amount to word - all this is available in this library.
https://github.com/cs-eliseev/helpers-word
collection collections cse framework helper helpers inclination library number2word php text tool tools transliteration utilities utility utils word
Last synced: about 2 months ago
JSON representation
The helpers allows you to modify string data. Inclination, transliterate, convert month date and convert number or amount to word - all this is available in this library.
- Host: GitHub
- URL: https://github.com/cs-eliseev/helpers-word
- Owner: cs-eliseev
- License: mit
- Created: 2019-01-12T05:08:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-28T09:09:19.000Z (almost 6 years ago)
- Last Synced: 2024-06-03T03:23:58.226Z (8 months ago)
- Topics: collection, collections, cse, framework, helper, helpers, inclination, library, number2word, php, text, tool, tools, transliteration, utilities, utility, utils, word
- Language: PHP
- Size: 50.8 KB
- Stars: 7
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
English | [Русский](https://github.com/cs-eliseev/helpers-word/blob/master/README.ru_RU.md)
WORD CSE HELPERS
=======
[](https://travis-ci.org/cs-eliseev/helpers-word)
[](https://codecov.io/gh/cs-eliseev/helpers-word)
[](https://scrutinizer-ci.com/g/cs-eliseev/helpers-word/?branch=master)
[](https://packagist.org/packages/cse/helpers-word)
[](https://packagist.org/packages/cse/helpers-word)
[](https://github.com/cs-eliseev/helpers-word/blob/master/LICENSE.md)
[](https://github.com/cs-eliseev/helpers-word/archive/master.zip)
The helpers allows you to modify string data. Inclination, transliterate, convert month date and convert number or amount to word - all this is available in this library.
Project repository: https://github.com/cs-eliseev/helpers-word
**DEMO**
```php
$number = 21;
Word::getInclinationByNumber(
$number,
['котик', 'котика', 'котиков'],
'мурлычит ' . Word::convertUnsignedIntNumberToWord($number) . ' '
);
// мурлычит двадцать один котик
```
***
## Introduction
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) is a collection of several libraries with simple functions written in PHP for people.
Despite using PHP as the main programming language for the Internet, its functions are not enough. WORD CSE HELPERS solves the problem: word inclination, word transliteration, number or sum conversion to a word, etc.
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.
**CSE Helpers project:**
* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)
* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)
* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)
* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)
* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)
* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)
* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)
* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)
* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)
* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)
* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)
Below you will find some information on how to init library and perform common commands.
## Install
You can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-word).
### Composer
Execute the following command to get the latest version of the package:
```bash
composer require cse/helpers-word
```
Or file composer.json should include the following contents:
```json
{
"require": {
"cse/helpers-word": "*"
}
}
```
### Git
Clone this repository locally:
```bash
git clone https://github.com/cs-eliseev/helpers-word.git
```
### Download
[Download the latest release here](https://github.com/cs-eliseev/helpers-word/archive/master.zip).
## Usage
The class consists of static methods that are conveniently used in any project. See example [examples-word.php](https://github.com/cs-eliseev/helpers-word/blob/master/examples/examples-word.php).
**Convert string to UTF-8**
Example default charset(CP1251):
```php
$text = mb_convert_encoding('привет', 'CP1251');
Word::stringToUtf($text);
// привет
```
Set charset:
```php
$text = mb_convert_encoding('привет', 'KOI8-R');
Word::stringToUtf($text, 'KOI8-R');
// привет
```
**Date month to word converter**
Example:
```php
Word::convertDateMonthToWord('2019-01-01');
// 01 января 2019
```
Add delimiter to result:
```php
Word::convertDateMonthToWord('05.05.2018', '/');
// 05/мая/2018
```
**Inclination**
Example:
```php
Word::getInclinationByNumber(10, ['котик', 'котика', 'котиков']);
// котиков
```
Add number:
```php
Word::getInclinationByNumber(0, ['%d котик', '%d котика', '%d котиков']);
// 0 котиков
```
Add string number to text:
```php
Word::getInclinationByNumber('01', ['был %d котик', 'было %d котика', 'было %d котиков']);
// был 1 котик
```
Add text prefix:
```php
Word::getInclinationByNumber(4, ['котик', 'котика', 'котиков'], 'еще %d ');
// еще 4 котика
```
**Text transliterate**
Example:
```php
Word::transliterate('12 пользователей online');
// 12 polzovateley online
```
**Convert number to word**
Example:
```php
Word::convertUnsignedIntNumberToWord(0);
// ноль
Word::convertUnsignedIntNumberToWord('1001');
// одна тысяча один
```
Change ones inclination:
```php
Word::convertUnsignedIntNumberToWord(2002, 0);
// две тысячи двe
```
**Convert amount to word**
Example:
```php
Word::convertAmountToWord(0);
// ноль рублей 0 копеек
```
Cents example:
```php
Word::convertAmountToWord('1001.1');
// одна тысяча один рубль 10 копеек
Word::convertAmountToWord(2012.01);
// две тысячи двенадцать рублей 01 копейка
```
Cents to word example:
```php
Word::convertAmountToWord(87654.02, true, true);
// восемьдесят семь тысяч шестьсот пятьдесят четыре рубля две копейки
```
Ignore zero cents:
```php
Word::convertAmountToWord('1098765.00', false);
// один миллион девяносто восемь тысяч семьсот шестьдесят пять рублей
```
**CamelCase converter**
Example:
```php
Word::camelCase('example-word');
// ExampleWord
```
Revert CamelCase:
```php
Word::camelCase('ExampleWord', true);
// example-word
```
Change delimiter:
```php
Word::camelCase('ExampleWord', true, '/');
// example/word
```
## Testing & Code Coverage
PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.
General PHPUnit documentation can be found at https://phpunit.de/documentation.html.
To run the PHPUnit unit tests, execute:
```bash
phpunit PATH/TO/PROJECT/tests/
```
If you want code coverage reports, use the following:
```bash
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
```
Used PHPUnit default config:
```bash
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
```
## Donating
You can support this project [here](https://www.paypal.me/cseliseev/10usd).
You can also help out by contributing to the project, or reporting bugs.
Even voicing your suggestions for features is great. Anything to help is much appreciated.
## License
The WORD CSE HELPERS is open-source PHP library licensed under the MIT license. Please see [License File](https://github.com/cs-eliseev/helpers-word/blob/master/LICENSE.md) for more information.
***
> GitHub [@cs-eliseev](https://github.com/cs-eliseev)