ctapu4ok/vk-messenger-sdk

PHP implementation of VK Messenger LongPoll protocol.

v1.1.1 2023-07-24 08:36 UTC

Requires

• php: ^8.2
• ext-curl: *
• amphp/amp: ^3
• amphp/file: ^3
• amphp/log: ^2
• amphp/mysql: ^3
• amphp/postgres: ^2
• amphp/redis: ^2
• guzzlehttp/guzzle: ^7.7
• psr/http-factory: ^1.0
• psr/log: ^3
• revolt/event-loop: ^1.0
• webmozart/assert: ^1.11

Requires (Dev)

• phpunit/phpunit: ^10.2
• squizlabs/php_codesniffer: 3.*

AGPL-3.0-only

• Shtepa Stanislav

• client
• sdk
• bot
• vk
• Messenger
• longpoll
• messager

README

Instructions in English

VK Messenger SDK представляет собой систему, которая позволяет взаимодействовать с API ВКонтакте через LongPoll в асинхронном режиме.

LongPoll - это механизм, предоставляемый API ВКонтакте, который позволяет получать обновления из социальной сети в режиме реального времени.

Для реализации асинхронного режима работы проект использует механизм обратных вызовов (callback / event loop). Когда происходит новое событие в системе ВКонтакте, обработчик получает его и вызывает соответствующий обратный вызов, который пользователь предварительно определил. Таким образом, пользователь может создать свою логику обработки полученных событий.

Библиотека PHP для взаимодействия с VK API, включающая LongPoll Server и API методы

Используемая версия ВК API version 5.81

1. Предусловия

• PHP 8.2^

2. Установка

The VK Messenger SDK можно установить с помощью Composer, выполнив следующую команду:

composer require ctapu4ok/vk-messenger-sdk

3. Примеры

(постепенно пополняется)

Пример простого бота

1. Сообщения

1. Отправление сообщения с кнопками
2. Имитация набора текста ботом
3. Отправка сообщений с вложенными фото

2. Группы

1. Получения информации о группе
2. Редактирование группы

3. Остальное

1. Выполнение SQL запроса
2. Выполнение транзакций
3. Пример с модулем Logger

Больше примеров

4. Пример бота

<?php declare(strict_types=1);

if (file_exists('vendor/autoload.php')) {
    require_once 'vendor/autoload.php';
}

use ctapu4ok\VkMessengerSdk\EventHandler;
use ctapu4ok\VkMessengerSdk\Logger;
use ctapu4ok\VkMessengerSdk\Settings;

enum Params
{
    public const API_HASH = 'vk1.a.Qyw6zef4YQZmosPX5J.....';
    public const GROUP_ID = 12345678;
    public const CONFIRM_STRING = 'c683e9eb12cebb65ce.....';

    public const VERSION = '5.81';
}

class MessengerEvent extends EventHandler
{
    public function onStart(): void
    {
        $this->getAPI()->logger('The event handler was initialized');
    }
    public function messageEvent(int $group_id, ?string $secret, array $object): void
    {
        $this->getAPI()->logger([
            'New message event received', $object
        ], Logger::LOGGER_CALLABLE);
    }
    public function messageNew(int $group_id, ?string $secret, array $object): void
    {
        $this->getAPI()->logger([
            'New message received: ', $object
        ], Logger::LOGGER_CALLABLE);

        /**
         * @var $this->getVk() The main VK API methods src/API/Actions
         */
        $msg_id = $this->getVk()->messages()->send([
            'user_id' => $object['message']['from_id'],
            'random_id' => floor(microtime(true) * 1000),
            'peer_id' => $object['message']['peer_id'],
            'message' => 'Hello World!'
        ]);

        $this->getAPI()->logger([
            'Getting Message ID: ', $msg_id
        ], Logger::LOGGER_CALLABLE);
    }

    public function messageTypingState(int $group_id, ?string $secret, array $object): void
    {
        $this->getAPI()->logger([
            'The user started typing a message', $object
        ], Logger::LOGGER_CALLABLE);
    }
    
    /**
    * Cron example  
    */ 
    #[Cron(period: 5)]
    public function testingCron5()
    {
        $this->getAPI()->logger([
            'THIS IS CRON 5!!!!!!'
        ], Logger::LOGGER_CALLABLE);
    }

    #[Cron(period: 1)]
    public function testingSome1()
    {
        $this->getAPI()->logger([
            'THIS IS CRON 1.0!!!!!!'
        ], Logger::LOGGER_CALLABLE);
    }
}

$Settings = new Settings();

$Settings->getAppInfo()->setApiHash(Params::API_HASH);
$Settings->getAppInfo()->setGroupId(Params::GROUP_ID);
$Settings->getAppInfo()->setConfirmString(Params::CONFIRM_STRING);
$Settings->getAppInfo()->setApiVersion(Params::VERSION);

// we say to output logs to a file (without console)
//$Settings->getLogger()
//    ->setType(Logger::LOGGER_FILE)
//    ->setExtra('log.file')
//    ->setMaxSize(50*1024*1024);
// Database settings
//$Settings->setDb(
//    (new Settings\Database\Mysql())
//    ->setUri('127.0.0.1:3306')
//    ->setDatabase('vk_messenger')
//    ->setUsername('root')
//    ->setPassword('root')
//);

MessengerEvent::loop($Settings);