atol-online/README.md

99 lines
5.3 KiB
Markdown
Raw Normal View History

2020-01-11 06:30:25 +00:00
# АТОЛ Онлайн
2021-12-02 08:14:01 +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)
2021-11-20 16:33:43 +00:00
2021-12-02 08:14:01 +00:00
Библиотека для фискализации чеков по 54-ФЗ через [облачную ККТ АТОЛ](https://online.atol.ru/).
**[Документация](/docs/readme.md)**
2021-11-20 16:33:43 +00:00
---
2021-12-02 08:14:01 +00:00
**В ветке `dev` проводится глубокий рефакторинг, стабилизация и активная подготовка к `v1.0.0`.
Документация актуализируется постепенно.**
2021-12-02 08:14:01 +00:00
---
2020-01-11 06:30:25 +00:00
| master | [![CI](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [![codecov](https://codecov.io/gh/anthonyaxenov/atol-online/branch/master/graph/badge.svg?token=WR2IV7FTF0)](https://codecov.io/gh/anthonyaxenov/atol-online) |
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| dev | [![CI dev](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [![codecov dev](https://codecov.io/gh/anthonyaxenov/atol-online/branch/dev/graph/badge.svg?token=WR2IV7FTF0)](https://codecov.io/gh/anthonyaxenov/atol-online) |
2021-12-01 12:12:11 +00:00
Текущие поддерживаемые версии АТОЛ Онлайн:
| Протокол | API | ФФД | Статус |
|----------|-----|------|-------------|
| v4 | 5.7 | 1.05 | Рефакторинг |
| v5 | 2.0 | 1.2 | В планах |
## Плюшечки
* Мониторинг ККТ и ФН
* Фискализация докумнетов на облачной ККТ
* Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
* Расчёты денег в копейках
* PSR-4 автозагрузка
2021-12-02 08:14:01 +00:00
<!--* Фактически полное покрытие тестами-->
2020-01-11 06:30:25 +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
## Начало работы
### Подключение библиотеки
1. Установить библиотеку пакет к проекту:
2020-01-11 06:30:25 +00:00
```bash
composer require axenov/atol-online
```
2. В нужном месте проекта подключить автозагрузчик composer-зависимостей, если это не сделано ранее:
2020-01-11 06:30:25 +00:00
```php
require($project_root . '/vendor/autoload.php');
2020-01-11 06:30:25 +00:00
```
где `$project_root` — абсолютный путь к корневой директории вашего проекта.
> При использовании фреймворков это обычно не требуется.
2020-01-11 06:30:25 +00:00
### Тестирование кода библиотеки
Файлы тестов находятся в директории `/tests` корня репозитория.
Для запуска тестов необходимо перейти в корень репозитория и выполнить одну из команд:
2020-01-11 06:30:25 +00:00
```bash
composer test # обычное тестирование
composer test-cov # тестирование с покрытием
2020-01-11 06:30:25 +00:00
```
После тестирования с покрытием создаётся отчёт в директории `.coverage-report` в корне репозитория.
2020-01-11 06:30:25 +00:00
## Использование библиотеки
Весь исходный код находится в директории [`/src`](/src).
**Комментарии phpdoc есть буквально везде. Прокомментировано вообще всё.**
2020-01-11 06:30:25 +00:00
1. Обращайтесь к [документации библиотеки](/docs).
2020-01-11 06:30:25 +00:00
2. Обращайтесь к [исходному коду](/src).
3. Обращайтесь к [тестам](/tests).
4. Используйте подсказки вашей IDE.
2020-01-11 06:30:25 +00:00
Тогда у вас не возникнет затруднений.
## Дополнительные ресурсы
* **[Документация к библиотеке](/docs/readme.md)**
* Telegram-канал: [@atolonline_php](https://t.me/atolonline_php)
* [Документация АТОЛ Онлайн](https://online.atol.ru/lib/)
2020-01-11 06:30:25 +00:00
## Лицензия
Вы имеете право использовать и распространят код из этого репозитория на условиях **[лицензии MIT](LICENSE)**.