2020-01-11 06:30:25 +00:00
|
|
|
|
# АТОЛ Онлайн
|
|
|
|
|
|
2021-11-20 16:33:43 +00:00
|
|
|
|
---
|
|
|
|
|
|
2021-11-28 04:01:28 +00:00
|
|
|
|
**В этой ветке проводится глубокий рефакторинг, стабилизация и активная подготовка к `v1.0.0`. Документация
|
|
|
|
|
актуализируется постепенно.**
|
2021-11-20 16:33:43 +00:00
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2021-05-25 03:48:37 +00:00
|
|
|
|
[![Master build](https://github.com/anthonyaxenov/atol-online/actions/workflows/master.yml/badge.svg)](https://github.com/anthonyaxenov/atol-online/actions/workflows/master.yml)
|
|
|
|
|
[![Dev build](https://github.com/anthonyaxenov/atol-online/actions/workflows/dev.yml/badge.svg)](https://github.com/anthonyaxenov/atol-online/actions/workflows/dev.yml)
|
2021-12-01 12:12:11 +00:00
|
|
|
|
[![Latest Stable Version](http://poser.pugx.org/axenov/atol-online/v)](https://packagist.org/packages/axenov/atol-online)
|
|
|
|
|
[![Latest Unstable Version](http://poser.pugx.org/axenov/atol-online/v/unstable)](https://packagist.org/packages/axenov/atol-online)
|
|
|
|
|
[![Total Downloads](http://poser.pugx.org/axenov/atol-online/downloads)](https://packagist.org/packages/axenov/atol-online)
|
|
|
|
|
[![License](http://poser.pugx.org/axenov/atol-online/license)](https://packagist.org/packages/axenov/atol-online)
|
2020-05-27 17:14:53 +00:00
|
|
|
|
|
2020-01-11 06:30:25 +00:00
|
|
|
|
Библиотека для фискализации чеков по 54-ФЗ через [облачную ККТ АТОЛ](https://online.atol.ru/).
|
|
|
|
|
|
2020-01-11 10:08:49 +00:00
|
|
|
|
**[Документация](/docs/readme.md)**
|
|
|
|
|
|
2021-12-01 12:12:11 +00:00
|
|
|
|
Текущие поддерживаемые версии АТОЛ Онлайн:
|
2021-11-28 04:01:28 +00:00
|
|
|
|
|
|
|
|
|
| Протокол | API | ФФД | Статус |
|
|
|
|
|
|----------|-----|------|-------------|
|
|
|
|
|
| v4 | 5.7 | 1.05 | Рефакторинг |
|
|
|
|
|
| v5 | 2.0 | 1.2 | В планах |
|
|
|
|
|
|
|
|
|
|
## Плюшечки
|
|
|
|
|
|
|
|
|
|
* Мониторинг ККТ и ФН
|
|
|
|
|
* Фискализация докумнетов на облачной ККТ
|
|
|
|
|
* Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
|
|
|
|
|
* Расчёты денег в копейках
|
|
|
|
|
* Фактически полное покрытие тестами
|
|
|
|
|
* PSR-4 автозагрузка
|
|
|
|
|
|
2020-01-11 06:30:25 +00:00
|
|
|
|
## Системные требования
|
|
|
|
|
|
2021-11-28 04:01:28 +00:00
|
|
|
|
* php8.0+
|
|
|
|
|
* [composer](https://getcomposer.org/)
|
|
|
|
|
* расширения php (скорее всего, устанавливать их отдельно не придётся):
|
|
|
|
|
* `php-json`
|
|
|
|
|
* `php-curl`
|
|
|
|
|
* `php-mbstring`
|
|
|
|
|
* `php-tokenizer`
|
2020-01-11 06:30:25 +00:00
|
|
|
|
|
|
|
|
|
## Начало работы
|
|
|
|
|
|
|
|
|
|
### Подключение библиотеки
|
|
|
|
|
|
2021-11-28 04:01:28 +00:00
|
|
|
|
1. Установить библиотеку пакет к проекту:
|
2020-01-11 06:30:25 +00:00
|
|
|
|
```bash
|
|
|
|
|
composer require axenov/atol-online
|
|
|
|
|
```
|
2021-11-28 04:01:28 +00:00
|
|
|
|
2. В нужном месте проекта подключить автозагрузчик composer-зависимостей, если это не сделано ранее:
|
2020-01-11 06:30:25 +00:00
|
|
|
|
```php
|
2021-11-28 04:01:28 +00:00
|
|
|
|
require($project_root . '/vendor/autoload.php');
|
2020-01-11 06:30:25 +00:00
|
|
|
|
```
|
2020-01-11 07:57:39 +00:00
|
|
|
|
где `$project_root` — абсолютный путь к корневой директории вашего проекта.
|
2021-11-28 04:01:28 +00:00
|
|
|
|
> При использовании фреймворков это обычно не требуется.
|
2020-01-11 06:30:25 +00:00
|
|
|
|
|
|
|
|
|
### Тестирование кода библиотеки
|
|
|
|
|
|
|
|
|
|
Файлы тестов находятся в директории `/tests` корня репозитория.
|
|
|
|
|
|
|
|
|
|
Для запуска тестов необходимо перейти в корень вашего проекта и выполнить команду:
|
|
|
|
|
|
|
|
|
|
```bash
|
2021-11-28 04:01:28 +00:00
|
|
|
|
composer test
|
2020-01-11 06:30:25 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Использование библиотеки
|
|
|
|
|
|
|
|
|
|
Весь исходный код находится в директории [`/src`](/src).
|
|
|
|
|
|
2021-11-28 04:01:28 +00:00
|
|
|
|
**Комментарии phpdoc есть буквально везде. Прокомментировано вообще всё.**
|
2020-01-11 06:30:25 +00:00
|
|
|
|
|
2021-11-28 04:01:28 +00:00
|
|
|
|
1. Обращайтесь к [документации библиотеки](/docs).
|
2020-01-11 06:30:25 +00:00
|
|
|
|
2. Обращайтесь к [исходному коду](/src).
|
2021-11-28 04:01:28 +00:00
|
|
|
|
3. Обращайтесь к [тестам](/tests).
|
|
|
|
|
4. Используйте подсказки вашей IDE.
|
2020-01-11 06:30:25 +00:00
|
|
|
|
|
|
|
|
|
Тогда у вас не возникнет затруднений.
|
|
|
|
|
|
|
|
|
|
## Дополнительные ресурсы
|
|
|
|
|
|
2021-12-01 17:10:54 +00:00
|
|
|
|
* **[Документация к библиотеке](/docs/readme.md)**
|
2021-11-28 04:01:28 +00:00
|
|
|
|
* Telegram-канал: [@atolonline_php](https://t.me/atolonline_php)
|
2021-12-01 17:10:54 +00:00
|
|
|
|
* [Документация АТОЛ Онлайн](https://online.atol.ru/lib/)
|
2021-11-28 04:01:28 +00:00
|
|
|
|
* Функционал, находящийся в разработке: [ROADMAP.md](ROADMAP.md)
|
2020-01-11 06:30:25 +00:00
|
|
|
|
|
|
|
|
|
## Лицензия
|
|
|
|
|
|
2021-11-28 04:01:28 +00:00
|
|
|
|
Вы имеете право использовать и распространят код из этого репозитория на условиях **[лицензии MIT](LICENSE)**.
|