5.3 KiB
АТОЛ Онлайн
Библиотека для фискализации чеков по 54-ФЗ через облачную ККТ АТОЛ.
В ветке dev
проводится глубокий рефакторинг, стабилизация и активная подготовка к v1.0.0
.
Документация актуализируется постепенно.
master | ||
---|---|---|
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
Начало работы
Подключение библиотеки
- Установить библиотеку пакет к проекту:
composer require axenov/atol-online
- В нужном месте проекта подключить автозагрузчик composer-зависимостей, если это не сделано ранее:
гдеrequire($project_root . '/vendor/autoload.php');
$project_root
— абсолютный путь к корневой директории вашего проекта.При использовании фреймворков это обычно не требуется.
Тестирование кода библиотеки
Файлы тестов находятся в директории /tests
корня репозитория.
Для запуска тестов необходимо перейти в корень репозитория и выполнить одну из команд:
composer test # обычное тестирование
composer test-cov # тестирование с покрытием
После тестирования с покрытием создаётся отчёт в директории .coverage-report
в корне репозитория.
Использование библиотеки
Весь исходный код находится в директории /src
.
Комментарии phpdoc есть буквально везде. Прокомментировано вообще всё.
- Обращайтесь к документации библиотеки.
- Обращайтесь к исходному коду.
- Обращайтесь к тестам.
- Используйте подсказки вашей IDE.
Тогда у вас не возникнет затруднений.
Дополнительные ресурсы
- Документация к библиотеке
- Telegram-канал: @atolonline_php
- Документация АТОЛ Онлайн
Лицензия
Вы имеете право использовать и распространят код из этого репозитория на условиях лицензии MIT.