Download the PHP package victor78/yii2-messenger-target without Composer

Yii2MessengerTarget

MessengerTarget for Yii2 for sending logs as text and/or as files (of which archives) through messengers. Now this extension supports as messenger only Telegram.

MessengerTarget для Yii2 для отправки логов как текст и/или как файлы(в том числе как архивы) через месенджеры. Сейчас расширение поддерживает в качестве месседжера только Телеграм.

English:

• Installation
• Configuration
  • How to create telegram bot
  • How to take telegram chat id which will receive messages from the bot
• How to use
• Notes

Русский:

• Установка
• Настройка
  • Как создать телеграм бота
  • Как получить id чата (id пользователя), который будет получать сообщения от бота
• Как использовать
• Замечания

Installation

The preferred way to install this extension is through composer.

Either run

or add

to the require section of your composer.json.

Configuration

How to create telegram bot

1. Message @botfather https://telegram.me/botfather with the following text: /newbot If you don't know how to message by username, click the search field on your Telegram app and type @botfather, where you should be able to initiate a conversation. Be careful not to send it to the wrong contact, because some users has similar usernames to botfather.

   

2. @botfather replies with Alright, a new bot. How are we going to call it? Please choose a name for your bot.

3. Type whatever name you want for your bot.

4. @botfather replies with

5. Type whatever username you want for your bot, minimum 5 characters, and must end with bot. For example: telesample_bot

6. @botfather replies with:

7. Note down the 'token' mentioned above.

8. Type /setprivacy to @botfather.

   

9. @botfather replies with Choose a bot to change group messages settings.

10. Type (or select) @telesample_bot (change to the username you set at step 5 above, but start it with @)

11. @botfather replies with

12. Type (or select) Disable to let your bot receive all messages sent to a group. This step is up to you actually.

13. @botfather replies with Success! The new status is: DISABLED. /help

How to take telegram chat id which will receive messages from the bot

Send the /my_id to telegram bot @get_id_bot or use the instruction.

How to use

It is enough to configure component right, and it will work. To test yout configuration, add it, for example, to some controller:

Notes

For archiving MessengerTarget use yii2-zipper.

• For zip type Zipper try to use console command zip or php zip extension, so one of them is required on server for zipping.
• For tar, tar.gz, tar.bz2 Zipper try to use GNU tar and BSD tar, so one ofo them is required on server for these ways of arching.
• For zipping by 7zip, the 7za utiliy is required on server.

Установка

Предпочтительный способ установки расширения через composer.

Либо запуск из консоли

либо в composer.json в секции required

Настройка

Как создать телеграм бота

1. Напишите боту @botfather https://telegram.me/botfather следующий текст (команду): /newbot Если вы не в курсе как отправить сообщение пользователю по его username, кликните по поиску вашего приложения Телеграм и наберите @botfather, где вы получите возможность начать переписку с данным пользователем (в данном случае - ботом). Будьте внимательны, поскольку некоторые пользователи используют схожий c botfather username.

   

2. @botfather ответит Alright, a new bot. How are we going to call it? Please choose a name for your bot.

3. Отправьте сообщение с именем бота в ответ.

4. @botfather ответит

5. Отправьте в ответе username для бота - оно должно быть длинее 5 символов, заканчиваться на bot. Например: telesample_bot

6. @botfather ответит:

7. Сохраните токен.

8. Отправьте боту @botfather сообщение /setprivacy.

   

9. @botfather ответит Choose a bot to change group messages settings.

10. Наберите (или выберите) вашего бота @telesample_bot (выберите по username вашего бота)

11. @botfather ответит

12. Наберите (или выберите) Disable чтобы позволить вашему боту работать у группах.

13. @botfather ответит Success! The new status is: DISABLED. /help

Как получить id чата (id пользователя), который будет получать сообщения от бота

Отправьте /my_id телеграм боту @get_id_bot или используйте инструкцию.

Как использовать

Достаточно настроить компонент верно, и логирование через мессенджер будет работать. Протестировать верно ли настроено логирование можно добавив следующий код, например, в контроллер:

Замечания

Для архивации файлов MessengerTarget использует yii2-zipper.

• Для архивирования в чистый zip используется утилита zip или расширение PHP для zip, так что или утилита, или расширение должны быть установлены на сервере для упавки и разупаковки zip.
• Для tar, tar.gz, tar.bz2 Zipper пытается использовать GNU tar или BSD tar, один из них должен быть установлен на сервере для этих типов архивов.
• Для упаковки/разупаковки zip при помощи 7zip, на сервере должа быть установлена утилита 7za.