max-messenger-bot / max-uploader-php
PHP library for uploading files via the Max Messenger Bot API
Package info
github.com/max-messenger-bot/max-bot-uploader-php
pkg:composer/max-messenger-bot/max-uploader-php
Requires
- php: ^8.2
- ext-mbstring: *
- max-messenger-bot/max-bot-api-php: ^1.0
Requires (Dev)
- codeception/codeception: ^5.3
- codeception/module-asserts: *
- friendsofphp/php-cs-fixer: ^3.95
- sebastian/diff: ^6.0
- symfony/console: ^7.4
- vimeo/psalm: ^7.10
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Этот пакет предназначен для загрузки медиафайлов на серверы API MAX в полностью объектно-ориентированном формате.
Multipart upload и Resumable upload методы.
Полный контроль над загрузкой.
Простой пример отправки сообщения с вложением:
use MaxMessenger\Bot\MaxApiClient; use MaxMessenger\Bot\Model\Request\NewMessageBody; use MaxMessenger\Uploader\MaxUploader; $apiClient = new MaxApiClient('your-access-token', useRussianTrustedCaCertificates: true); $uploader = new MaxUploader($apiClient); $fileToken = $uploader->uploadFile(__FILE__); $message = NewMessageBody::new() ->addFileAttachment($fileToken); $apiClient->sendMessageToUser(12345678, $message);
Warning
По поводу ошибок в клиенте, пожалуйста обращайтесь ко мне напрямую:
Important
В конструкторах используйте именованные параметры: состав и порядок параметров повторяют схему API и могут измениться при её обновлении. Именованные параметры обеспечивают обратную совместимость.
Note
Возобновление загрузки с места прерывания доступно не всегда. Сервера МАКС сами определяют, можно ли возобновить загрузку или её нужно начать с начала. Загрузчик выполняет требования сервера, поэтому загрузка с начала не является ошибкой загрузчика.
Основные особенности
- Реализована загрузка медиафайлов на сервера обоими поддерживаемыми способами.
- Возможность вести логи, следить за происходящими процессами, следить за прогрессом загрузки.
- Это полностью объектно-ориентированный код без array shapes (object-like arrays).
- Для загрузки медиафайлов не требуется изучение официального API.
- В большинстве случаев для понимания работы, Вам достаточно будет посмотреть примеры кода.
- Весь функционал разбит на слои, каждый слой может быть частично или полностью заменён Вашей реализацией.
Способы загрузки
- Multipart upload — Более простой, но менее надёжный способ загрузки
(реализован классом
MaxMultipartFormUploader). - Resumable upload — Рекомендуемый способ загрузки (реализован классом
MaxUploader).
Оба загрузчика принимают необязательный второй аргумент MaxUploaderHttpClientInterface.
Можно передать собственную реализацию интерфейса или экземпляр MaxUploaderHttpClient.
Без второго аргумента клиент загрузки создаётся из HTTP-клиента основного клиента API.
Клиент API и текущий клиент загрузки доступны через getApiClient() и getMaxUploaderHttpClient().
Документация в коде
I believe that documentation in public code should be in English. However, the documentation in this project is written in Russian because the messenger is aimed at a Russian-speaking audience, and Russian is the primary language of developers who create bots for it.
Я считаю, что документация в публичном коде должна быть на английском языке. Однако документация в этом проекте написана на русском языке, поскольку мессенджер ориентирован на русскоязычную аудиторию, а русский — основной язык разработчиков, создающих для него ботов.
Установка
composer require max-messenger-bot/max-bot-uploader-php:"*"
Note
Ограничение "*" позволяет Composer подобрать версию загрузчика, совместимую с установленной версией
основного пакета max-messenger-bot/max-bot-api-php.
Требования
- PHP 8.2+
- ext-mbstring
Зависимости
max-messenger-bot/max-bot-api-php^1.0
Примеры
Больше примеров смотрите в документации в разделе примеры.