anthony/atol-online
1
0
Fork 0
mirror of https://github.com/anthonyaxenov/atol-online.git synced 2024-11-25 03:34:13 +00:00
Code Issues Projects Releases Wiki Activity
Зеркало из GitHub. Библиотека для работы с АТОЛ Онлайн (облачная ККТ для приёма платежей по 54-ФЗ). https://packagist.org/packages/axenov/atol-online
160 Commits 3 Branches 21 Tags 575 KiB
PHP 100%
e22c1cb091
Go to file
AnthonyAxenov e22c1cb091 Финализация оставшихся классов
2021-12-19 22:50:52 +08:00
.github Настройка gh-actions для работы с codecov.io 2021-12-02 15:56:32 +08:00
docs Более или менее актуальная документация 2021-12-19 22:30:21 +08:00
src Финализация оставшихся классов 2021-12-19 22:50:52 +08:00
tests/AtolOnline/Tests Переименования классов для пущей простоты 2021-12-19 22:29:53 +08:00
.gitignore Настройка gh-actions для работы с codecov.io 2021-12-02 15:56:32 +08:00
composer.json Мелочи по конфигу composer 2021-12-18 14:09:07 +08:00
composer.lock Обновление зависимостей 2021-12-11 15:54:42 +08:00
LICENSE Initial commit, v0.1.0-b 2020-01-11 14:30:25 +08:00
phpunit.xml Более корректный порядок тестов 2021-12-12 14:36:04 +08:00
README.md Допокрытие ArrayAccess-методов 2021-12-12 11:09:12 +08:00

README.md

АТОЛ Онлайн

Latest Stable Version Latest Unstable Version Packagist PHP Version Support Total Downloads License

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

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

В ветке dev проводится глубокий рефакторинг, стабилизация и активная подготовка к v1.0.0. Документация актуализируется постепенно.

master GitHub Workflow Status (master) codecov
dev GitHub Workflow Status (dev) codecov dev

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

Протокол API ФФД Статус
v4 5.8 1.05 Рефакторинг
v5 2.0 1.2 В планах

Плюшечки

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

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

  • php8.0+
  • composer
  • расширения php (скорее всего, устанавливать их отдельно не придётся):
    • php-json
    • php-curl
    • php-mbstring
    • php-tokenizer

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

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

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

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

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

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

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

composer test # обычное тестирование
composer test-cov # тестирование с покрытием

После тестирования с покрытием создаётся отчёт в директории .coverage-report в корне репозитория.

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

Весь исходный код находится в директории /src.

Комментарии phpdoc есть буквально везде. Прокомментировано вообще всё.

  1. Обращайтесь к документации библиотеки.
  2. Обращайтесь к исходному коду.
  3. Обращайтесь к тестам.
  4. Используйте подсказки вашей IDE.

Тогда у вас не возникнет затруднений.

Дополнительные ресурсы

Лицензия

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