Skip to content

Latest commit

 

History

History
258 lines (190 loc) · 9.63 KB

README.ru_RU.md

File metadata and controls

258 lines (190 loc) · 9.63 KB
Raw

English | Русский

WORD CSE HELPERS

Travis (.org) Codecov Scrutinizer code quality

Packagist Minimum PHP Version Packagist GitHub repo size

Данная библиотек позволяет удобно работать с текстовыми данными. Доступны методы для преобразования наклонения, транслита, преобразования даты и чисел и прочее.

Репозиторий проекта: https://github.com/cs-eliseev/helpers-word

DEMO

$number = 21;
Word::getInclinationByNumber(
    $number,
    ['котик', 'котика', 'котиков'],
    'мурлычит ' . Word::convertUnsignedIntNumberToWord($number) . ' '
);
// мурлычит двадцать один котик

Описание проекта

CSE HELPERS - это набор из небольших библиотек с простыми функциями написанных на PHP специально для вас.

Несмотря на повсеместное использование PHP в качестве основного языка для WEB разработки, его зачастую недостаточно. WORD CSE HELPERS, позволит вам довольно просто склонять слова, преобразовывать числа и суммы, обрабатывать даты и д.р.

CSE HELPERS создан для быстрой разработки веб-приложений.

Список библиотек CSE Helpers:

Ниже представлена информация об установке и перечне команд с примерами их использования.

Установка

Самая последняя версия проекта доступна здесь.

Composer

Чтобы установить последнюю версию проекта, выполните следующую команду в терминале:

composer require cse/helpers-word

Или добавьте следующее содержимое в файл composer.json:

{
    "require": {
        "cse/helpers-word": "*"
    }
}

Git

Добавить этот репозиторий локально можно следующим образом:

git clone https://github.com/cs-eliseev/helpers-word.git

Скачать

Скачать последнюю версию проекта можно здесь.

Использование

Данный класс использует статические методы, которые удобно использовать в любом проекте. Смотрите пример examples-word.php.

Преобразовать в UTF-8

Пример (CP1251):

$text = mb_convert_encoding('привет', 'CP1251');
Word::stringToUtf($text);
// привет

Установка кодировки:

$text = mb_convert_encoding('привет', 'KOI8-R');
Word::stringToUtf($text, 'KOI8-R');
// привет

Преобразовать месяц из даты в текст

Пример:

Word::convertDateMonthToWord('2019-01-01');
// 01 января 2019

Установить разделитель:

Word::convertDateMonthToWord('05.05.2018', '/');
// 05/мая/2018

Наклонение слова

Пример:

Word::getInclinationByNumber(10, ['котик', 'котика', 'котиков']);
// котиков

Добавить число:

Word::getInclinationByNumber(0, ['%d котик', '%d котика', '%d котиков']);
// 0 котиков

Добавить текст перед числом:

Word::getInclinationByNumber('01', ['был %d котик', 'было %d котика', 'было %d котиков']);
// был 1 котик

Добавить префикс:

   Word::getInclinationByNumber(4, ['котик', 'котика', 'котиков'], 'еще %d ');
// еще 4 котика

Транслит теста

Пример:

Word::transliterate('12 пользователей online');
// 12 polzovateley online

Приобразования числа в текст

Пример:

Word::convertUnsignedIntNumberToWord(0);
// ноль
Word::convertUnsignedIntNumberToWord('1001');
// одна тысяча один

Изменение наклонения:

Word::convertUnsignedIntNumberToWord(2002, 0);
// две тысячи двe

Преобразование суммы в текст

Пример:

Word::convertAmountToWord(0);
// ноль рублей 0 копеек

Пример с копейками:

Word::convertAmountToWord('1001.1');
// одна тысяча один рубль 10 копеек
Word::convertAmountToWord(2012.01);
// две тысячи двенадцать рублей 01 копейка

Приобразование копеек в текст:

Word::convertAmountToWord(87654.02, true, true);
// восемьдесят семь тысяч шестьсот пятьдесят четыре рубля две копейки

Скрывать пустые копейки:

Word::convertAmountToWord('1098765.00', false);
// один миллион девяносто восемь тысяч семьсот шестьдесят пять рублей

Преобразовать в CamelCase

Пример:

Word::camelCase('example-word');
// ExampleWord

Преобразовать из CamelCase:

Word::camelCase('ExampleWord', true);
// example-word

Изменить разделитель:

Word::camelCase('ExampleWord', true, '/');
// example/word

Тестирование и покрытие кода

PHPUnit используется для модульного тестирования. Данные тесты гарантируют, что методы класса выполняют свою задачу.

Подробную документацию по PHPUnit можно найти по адресу: https://phpunit.de/documentation.html.

Чтобы запустить тесты выполните:

phpunit PATH/TO/PROJECT/tests/

Чтобы сформировать отчет о покрытии тестами кода, необходимо выполнить следующую команду:

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

Чтобы использовать настройки по умолчанию, достаточно выполнить:

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

Вклад в общее дело

Вы можите поддержать данный проект здесь. Вы также можете помочь, внеся свой вклад в проект или сообщив об ошибках. Даже высказывать свои предложения по функциям - это здорово. Все, что поможет, высоко ценится.

Лицензия

WORD CSE HELPERS это PHP-библиотека с открытым исходным кодом распространяемая по лицензии MIT. Для получения более подробной информации, пожалуйста, ознакомьтесь с лицензионным файлом.

GitHub @cs-eliseev