Download the PHP package kosmosafive/kosmosafive.cbrrates without Composer
On this page you can find all versions of the php package kosmosafive/kosmosafive.cbrrates. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kosmosafive/kosmosafive.cbrrates
More information about kosmosafive/kosmosafive.cbrrates
Files in kosmosafive/kosmosafive.cbrrates
Package kosmosafive.cbrrates
Short Description Курсы валют ЦБ РФ
License Apache-2.0
Homepage https://github.com/kosmosafive/kosmosafive.cbrrates
Informations about the package kosmosafive.cbrrates
Kosmosafive: CBR Rates
Получение котировок валют Центрального банка Российской Федерации.
Установка
В composer.json (пример для директории local) проекта добавьте
- установить модуль
Конфигурация модуля
Конфигурацию рекомендуется указывать в файле /bitrix/.settings_extra.php.
- adapter — настройки адаптера
Использование
Отправлять запросы можно как напрямую (сервис Kosmosafive\CBRRates\CBRApiInterface::class), так и с помощью сервиса-обертки (сервис Kosmosafive\CBRRates\Service\ApiServiceInterface::class).
Использование напрямую
-
Получить клиент
- Выполнить запрос
Использование сервиса-обертки
Реализованы методы:
- получение котировок на заданный на день | getDailyRates(?Type\Date $date = null)
- справочник по кодам валют | getCurrencies()
- обновление котировок на заданный день | updateDailyRates(Type\Date $date)
-
Получить сервис
- Выполнить запрос
Клиент
Поддерживается множество клиентов. Клиент идентифицируется по ключу. По умолчанию создается клиент с ключом default. Добавить собственный клиент можно программно.
События
onGetClient
Вызывается при вызове метода $apiService->getClient, когда клиент не был найден. В параметрах передается key — идентификатор запрошенного клиента. Обратно необходимо вернуть Клиент в параметре client.
Маршруты
- Scripts
-
- XmlDaily: get
-
- XmlValFul: get
Логирование
Реализована поддержка логгера, реализующего интерфейс PSR-3, указанного в конфигурации системы (Разработчик Bitrix Framework: Логгеры).
Расширенный логгер доступен при реализации интерфейса Kosmosafive\CBRRates\Diag\Logger\HttpLoggerInterface:
Модуль содержит расширенную файловую реализацию логгера — Kosmosafive\CBRRates\Diag\Logger\FileHttpLogger
Поиск логгера будет осуществлен по ключам kosmosafive.cbrrates и default.
Исключения
- Kosmosafive\CBRRates\Exception\Exception
- Kosmosafive\CBRRates\Http\Exception\RequestException
Интерфейс командной строки
Обновление котировок за указанный день \ период
- from — Дата \ Дата начала периода (YYYY-MM-DD)
- to — (опционально) Дата конца периода (YYYY-MM-DD)