Зеркало из GitHub. Библиотека для работы с АТОЛ Онлайн (облачная ККТ для приёма платежей по 54-ФЗ). https://packagist.org/packages/axenov/atol-online
Go to file
2021-12-11 15:53:57 +08:00
.github Настройка gh-actions для работы с codecov.io 2021-12-02 15:56:32 +08:00
docs Правки по документации 2021-11-28 12:01:28 +08:00
src Класс документа коррекции Correction с покрытием и всякая мелочёвка 2021-12-11 15:53:57 +08:00
tests/AtolOnline/Tests Класс документа коррекции Correction с покрытием и всякая мелочёвка 2021-12-11 15:53:57 +08:00
.gitignore Настройка gh-actions для работы с codecov.io 2021-12-02 15:56:32 +08:00
composer.json Минорные апдейты зависимостей 2021-12-08 16:11:39 +08:00
composer.lock Минорные апдейты зависимостей 2021-12-08 16:11:39 +08:00
LICENSE Initial commit, v0.1.0-b 2020-01-11 14:30:25 +08:00
phpunit.xml Мелочи в readme и phpunit.xml (удалены дефолтные параметры) 2021-12-02 01:10:54 +08:00
README.md Более симпатичные бейджики в README 2021-12-09 20:14:35 +08:00

АТОЛ Онлайн

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.7 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.