atol-online/README.md

АТОЛ Онлайн

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

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

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

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

Состояние веток:

master
dev

Плюшечки

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

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

• 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 coverage # тестирование с покрытием

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

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

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

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

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

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

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

• Документация АТОЛ Онлайн

Лицензия

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