anthony/atol-online
1
0
Fork 0
mirror of https://github.com/anthonyaxenov/atol-online.git synced 2024-12-30 17:03:53 +00:00
Code Issues Projects Releases Wiki Activity
Зеркало из GitHub. Библиотека для работы с АТОЛ Онлайн (облачная ККТ для приёма платежей по 54-ФЗ). https://packagist.org/packages/axenov/atol-online
180 Commits 3 Branches 21 Tags 575 KiB
PHP 100%
2ab45e8c28
Go to file
AnthonyAxenov 2ab45e8c28
Мелочи по докам, TODO в README
2022-12-15 09:34:57 +08:00
.github Ссылки на пожертвования 2022-12-14 23:52:39 +08:00
docs Мелочи по докам, TODO в README 2022-12-15 09:34:57 +08:00
src Миграция на php8.1 2022-12-15 00:19:55 +08:00
tests/AtolOnline/Tests Миграция на php8.1 2022-12-15 00:19:55 +08:00
.gitignore Настройка gh-actions для работы с codecov.io 2021-12-02 15:56:32 +08:00
.php-cs-fixer.php Подчищен composer.json 2022-12-15 00:24:03 +08:00
composer.json Подчищен composer.json 2022-12-15 00:24:03 +08:00
composer.lock Подчищен composer.json 2022-12-15 00:24:03 +08:00
LICENSE Initial commit, v0.1.0-b 2020-01-11 14:30:25 +08:00
phpcs.xml Подчищен composer.json 2022-12-15 00:24:03 +08:00
phpunit.xml Более корректный порядок тестов 2021-12-12 14:36:04 +08:00
psalm.xml Подчищен composer.json 2022-12-15 00:24:03 +08:00
README.md Мелочи по докам, TODO в README 2022-12-15 09:34:57 +08:00

README.md

АТОЛ Онлайн

Библиотека для фискализации чеков по 54-ФЗ через облачные ККТ АТОЛ.

GitHub Workflow Status (master) codecov Stable Version Packagist PHP Version Support License buymeacoffee

Документация

Текущие поддерживаемые версии АТОЛ Онлайн:

Протокол API ФФД Статус
v4 5.10 1.05 Поддерживается
v5 3.0 1.2 В планах

Поддерживаемые возможности:

  • Мониторинг ККТ и ФН
  • Фискализация документов на облачной ККТ
  • Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
  • Расчёты денег в копейках
  • PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters, докблоки

Системные требования

  • php v8.1 и выше
  • php-json
  • php-mbstring
  • composer

Начало работы

Подключение библиотеки

  1. Подключить пакет к проекту: 
    composer require axenov/atol-online
  2. В нужном месте проекта подключить автозагрузчик composer-зависимостей, если это не сделано ранее: 
    require($project_root . '/vendor/autoload.php');
    где $project_root — абсолютный путь к корневой директории вашего проекта.

    При использовании фреймворков это обычно не требуется.

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

Вы имеете право использовать и распространять код на условиях лицензии MIT.

Дополнительная информация может быть найдена здесь:

  1. Документации к библиотеке
  2. Документация АТОЛ Онлайн
  3. Исходный код, докблоки
  4. Тесты

Тестирование кода библиотеки

Файлы тестов находятся в директории /tests корня репозитория.

Для запуска тестов необходимо перейти в корень репозитория и выполнить одну из команд:

composer psalm    # статический анализ
composer phpcs    # синтаксический анализ
composer test     # полное тестирование без покрытия
composer coverage # полное тестирование с покрытием

После тестирования с покрытием в корне репозитория создаётся отчёт, который сохраняется в директории .coverage. Для тестирования с покрытием необходим php-xdebug с параметром xdebug.mode = coverage,....

TODO

  • Поддержка логирования через psr/log (psr-3)
  • Поддержка кеширования через psr/cache (psr-6)
  • Поддержка сторонних клиентов через psr/http-client (psr-18), отвязка от Guzzle
  • События
  • Поддержка ФФД 1.2 (разделение версий библиотеки по веткам?)
  • ...