devgoeth/tbot

PHP mini-framework for creating telegram bots.

Installation

``` bash cd /path/to/project composer require devgoeth/tbot @dev, <sub>(*1)</sub>

#### Execute migration
``` bash
php yii migrate --migrationPath=./vendor/devgoeth/tbot/migrations --interactive=0

Overview

Migration create Folders and Files:, <sub>(*2)</sub>

/frontend/components/tbot
/frontend/components/tbot/config/menu.php
/frontend/components/tbot/config/params.php
/frontend/components/tbot/controllers/DefaultController.php

Examples

You might view example with migration., <sub>(*3)</sub>

1. Step

Edit /frontend/components/tbot/config/params.php and write your apibot token in array of params., <sub>(*4)</sub>

``` php <?php return [ 'token' => '' ];, <sub>(*5)</sub>

#### 2. Step

Set Webhook for your bot, for example.
``` php
$url = 'https://' . $_SERVER['SERVER_NAME'] . '/test/web-hook';
$crt = './../../ssl/bundle.crt';

$bot = new \devgoeth\tbot\Base();
$bot->setWebHook($url, $crt);

And now telegram will be send data to your web-hook action, <sub>(*6)</sub>

3. Step

Use web-hook in Yii controller action. Don't forget to disable csrf validation for your web-hook action ``` php public function actionWebHook(){ $bot = new \devgoeth\tbot\Base(); $bot->webHook(); }, <sub>(*7)</sub>

#### 4. Step

Edit menu array for your buttons

/frontend/components/tbot/config/menu.php

For Example:
``` php
<?php
return [
    'noneMenuFunctions' => [
        ['/start' => 'Default/start'],
        ['/other' => 'Default/start'],
    ],
    'default' => [
        ['The Button' => 'Default/button'],
        [
            'The Wizard' => 'Default/wizard',
            'The Input' => 'Default/input'
        ],
    ]
];

Where is 'Label for Button' => 'controllerName/functionName', all function which execute whithout menu must be in 'noneMenuFunction' array, <sub>(*8)</sub>

All controllers for menu array must be in tbot/controllers, <sub>(*9)</sub>

Inline mode

Your can turn on inline mode in message. In tbot Controller function., <sub>(*10)</sub>

``` php public function start(){ return [ 'message' => 'Welcome to bot', 'keyboard' => [ [ ['text' => 'Label for button', 'callback_data' => 'command'] ] ], 'inline' => true ]; }, <sub>(*11)</sub>

or just link

``` php
public function start(){
    return [
        'message' => 'Welcome to bot',
        'keyboard' => [
            [
                ['text' => 'Google', 'url' => 'https://google.com']
            ]
        ],
        'inline' => true
    ];
}

Input mode

In tbot/controllers/DefaultController.php (Don't forget to create button 'The Input' => 'Default/input' in menu.php) You must add prefix Input for your function and it will be execute after main function., <sub>(*12)</sub>

``` php public function input(){ return [ 'message' => 'Input value, pls', 'keyboard' => 'default', ]; }, <sub>(*13)</sub>

public function inputInput(){ return [ 'message' => 'Your value ' . $this->params->message->text, 'keyboard' => 'default', ]; }, <sub>(*14)</sub>

### Wizard Mode

You can execute command from function in tbot Controllers and create step by step wizards

``` php
public function wizard(){
    return $this->base->executeCommand('Default/input');
}

Base

In Controller you can use base parameter which contain all base parameters include object of TelegramBot\Api https://github.com/TelegramBot/Api, <sub>(*15)</sub>

``` php public function myMessage(){ $keyboard = new \TelegramBot\Api\Types\ReplyKeyboardMarkup(array(array("one", "two", "three")), false); $message = 'It\'s awesome';, <sub>(*16)</sub>

// $this->base->markUp = 'html' by default; 
$this->base->bot->sendMessage(
    $this->params->message->chat->id, 
    $message, $this->base->markUp, 
    false, 
    null, 
    $keyboard
);
return [
    'message' => 'Input value, pls',
    'keyboard' => 'default',
];

}, <sub>(*17)</sub>

You can access previus comand's parameters.

``` php
$this->base->state->parameters;

You can send message, <sub>(*18)</sub>

``` php $this->base->send($text);, <sub>(*19)</sub>

Also you can disappear keyboard menu. In tbot action use and next message will disappear keyboard

``` php
$this->base->visible = true;