rusadrako/telegram_notification

Опопещения в телеграмм

1.3.0 2024-06-19 07:07 UTC

This package is not auto-updated.

Last update: 2024-09-25 08:19:26 UTC


README

Простые оповещения в телеграмм-бот

Version Total Downloads License

Установка (composer)

composer require 'rusadrako/telegram_notification'

Установка (manual)

  • Скачать и распоковать библиотеку.
  • Добавить в код инструкцию:
require_once('/telegram_notification/src/autoload.php')

Класс Bot

Базовый класс подключения к телеграмм-боту.

use RusaDrako\telegram_notification\Bot;

$token = 'botToken'; // токен телеграм-бота
$options = [];

$tn_bot = new Bot($token, $options);

или

$token = 'botToken'; // токен телеграм-бота
$options = [];

$tn_bot = new RD_TG_Bot($token, $options);

Доступные свойств:

$options = [
    'timeout' => 15, // время ожидания ответа от сервиса в секундах
    'marker' => 'Сервисное сообщение с test.ru: ', // маркер сообщений
];

Метод send()

Отправлят сообщения

$chat_id = 'USER_ID';
$message = 'test message';

/** @var RusaDrako\telegram_notification\Bot $tn_bot */
$tn_bot->send($chat_id, $message);
  • $chat_id - ID пользователя, которому отправляется сообщение
  • $message - Текст сообщения

Метод sendPhoto()

Отправлят сообщения с картинкой

$chat_id = 'USER_ID';
$file_path = __DIR__.'/test.jpg';
$message = 'test message';

/** @var RusaDrako\telegram_notification\Bot $tn_bot */
$tn_bot->sendPhoto($chat_id, $file_path, $message);
  • $chat_id - ID пользователя, которому отправляется сообщение
  • $file_path - Путь к файлу
  • $message - Текст сообщения

Метод set_token()

Устанавливает токен телеграм-бота.

/** @var RusaDrako\telegram_notification\Bot $tn_bot */
$tn_bot->set_token('...');

Метод set_timeout()

Устанавливает время ожидания ответа от сервиса в секундах.

/** @var RusaDrako\telegram_notification\Bot $tn_bot */
$tn_bot->set_timeout(15);

Метод set_marker()

Устанавливает маркер сообщений - добавляется перед текстом в сообщения.

/** @var RusaDrako\telegram_notification\Bot $tn_bot */
$tn_bot->set_marker('-->');

Метод set_timeout()

Устанавливает время ожидания ответа от сервиса в секундах.

/** @var RusaDrako\telegram_notification\Bot $tn_bot */
$tn_bot->set_timeout(15);

Класс Bilder

Управляющий класс для работы с несколькими ботами.

use RusaDrako\telegram_notification\Bilder;

$bilder = new Bilder(Bilder);

Метод get($token)

Возвращает объект подключения по токену.

$token = 'botToken'; // токен телеграм-бота

/** @var RusaDrako\telegram_notification\Bilder $bilder */
$tn_bot = $bilder->get($token);
  • $token - токен телеграм-бота

Метод delete($tn_bot)

Удаляет объект подключения из списка подключений.

/** @var RusaDrako\telegram_notification\Bilder $bilder */
$bilder->delete($tn_bot);
  • $tn_bot - Объект подключения к телеграм-боту

License

Copyright (c) Petukhov Leonid. Distributed under the MIT.