1+ <img src =" assets/logo/512px/logo_plain.png " title =" PHP Telegram Bot " alt =" PHP Telegram Bot logo " >
2+
13# PHP Telegram Bot
24
5+ A Telegram Bot based on the official [ Telegram Bot API] [ Telegram-Bot-API ]
6+
37[ ![ Join the bot support group on Telegram] ( https://img.shields.io/badge/telegram-@PHP__Telegram__Bot__Support-32a2da.svg )] ( https://telegram.me/PHP_Telegram_Bot_Support )
48[ ![ Donate] ( https://img.shields.io/badge/%F0%9F%92%99-Donate-blue.svg )] ( #donate )
59
610[ ![ Build Status] ( https://travis-ci.org/php-telegram-bot/core.svg?branch=master )] ( https://travis-ci.org/php-telegram-bot/core )
711[ ![ Dependencies] ( https://tidelift.com/badges/github/php-telegram-bot/core )] [ Tidelift ]
8- [ ![ Code Coverage] ( https://img.shields.io/scrutinizer/coverage/g/php-telegram-bot/core/develop .svg?style=flat-square )] ( https://scrutinizer-ci.com/g/php-telegram-bot/core/?b=develop )
9- [ ![ Code Quality] ( https://img.shields.io/scrutinizer/g/php-telegram-bot/core/develop .svg?style=flat-square )] ( https://scrutinizer-ci.com/g/php-telegram-bot/core/?b=develop )
10- [ ![ Latest Stable Version] ( https://img.shields.io/packagist/v/Longman /telegram-bot.svg )] ( https://packagist.org/packages/longman/telegram-bot )
11- [ ![ Total Downloads] ( https://img.shields.io/packagist/dt/Longman /telegram-bot.svg )] ( https://packagist.org/packages/longman/telegram-bot )
12- [ ![ Downloads Month] ( https://img.shields.io/packagist/dm/Longman /telegram-bot.svg )] ( https://packagist.org/packages/longman/telegram-bot )
12+ [ ![ Code Coverage] ( https://img.shields.io/scrutinizer/coverage/g/php-telegram-bot/core/master .svg?style=flat-square )] ( https://scrutinizer-ci.com/g/php-telegram-bot/core/?b=master )
13+ [ ![ Code Quality] ( https://img.shields.io/scrutinizer/g/php-telegram-bot/core/master .svg?style=flat-square )] ( https://scrutinizer-ci.com/g/php-telegram-bot/core/?b=master )
14+ [ ![ Latest Stable Version] ( https://img.shields.io/packagist/v/longman /telegram-bot.svg )] ( https://packagist.org/packages/longman/telegram-bot )
15+ [ ![ Total Downloads] ( https://img.shields.io/packagist/dt/longman /telegram-bot.svg )] ( https://packagist.org/packages/longman/telegram-bot )
16+ [ ![ Downloads Month] ( https://img.shields.io/packagist/dm/longman /telegram-bot.svg )] ( https://packagist.org/packages/longman/telegram-bot )
1317[ ![ Minimum PHP Version] ( http://img.shields.io/badge/php-%3E%3D5.6-8892BF.svg )] ( https://php.net/ )
1418[ ![ License] ( https://img.shields.io/packagist/l/longman/telegram-bot.svg )] ( https://github.com/php-telegram-bot/core/LICENSE )
1519
@@ -23,10 +27,11 @@ A Telegram Bot based on the official [Telegram Bot API][Telegram-Bot-API]
2327 - [ Create your first bot] ( #create-your-first-bot )
2428 - [ Require this package with Composer] ( #require-this-package-with-composer )
2529 - [ Choose how to retrieve Telegram updates] ( #choose-how-to-retrieve-telegram-updates )
26- - [ Webhook installation] ( #webhook-installation )
30+ - [ Webhook installation] ( #webhook-installation )
2731 - [ Self Signed Certificate] ( #self-signed-certificate )
2832 - [ Unset Webhook] ( #unset-webhook )
29- - [ getUpdates installation] ( #getupdates-installation )
33+ - [ getUpdates installation] ( #getupdates-installation )
34+ - [ getUpdates without database] ( #getupdates-without-database )
3035- [ Support] ( #support )
3136 - [ Types] ( #types )
3237 - [ Inline Query] ( #inline-query )
@@ -39,14 +44,15 @@ A Telegram Bot based on the official [Telegram Bot API][Telegram-Bot-API]
3944 - [ Send message to all active chats] ( #send-message-to-all-active-chats )
4045- [ Utils] ( #utils )
4146 - [ MySQL storage (Recommended)] ( #mysql-storage-recommended )
47+ - [ External Database connection] ( #external-database-connection )
4248 - [ Channels Support] ( #channels-support )
4349- [ Commands] ( #commands )
4450 - [ Predefined Commands] ( #predefined-commands )
4551 - [ Custom Commands] ( #custom-commands )
4652 - [ Commands Configuration] ( #commands-configuration )
47- - [ Admin Commands] ( #admin-commands )
48- - [ Set Admins] ( #set-admins )
49- - [ Channel Administration] ( #channel-administration )
53+ - [ Admin Commands] ( #admin-commands )
54+ - [ Set Admins] ( #set-admins )
55+ - [ Channel Administration] ( #channel-administration )
5056- [ Upload and Download directory path] ( #upload-and-download-directory-path )
5157- [ Logging] ( doc/01-utils.md )
5258- [ Documentation] ( #documentation )
@@ -180,15 +186,14 @@ composer require longman/telegram-bot
180186
181187### Choose how to retrieve Telegram updates
182188
183- The bot can handle updates with ** Webhook** or ** getUpdates** method:
189+ The bot can handle updates with [ ** Webhook** ] ( #webhook-installation ) or [ ** getUpdates** ] ( #getupdates-installation ) method:
184190
185191| | Webhook | getUpdates |
186192| ---- | :----: | :----: |
187193| Description | Telegram sends the updates directly to your host | You have to fetch Telegram updates manually |
188194| Host with https | Required | Not required |
189195| MySQL | Not required | ([ Not] ( #getupdates-without-database ) ) Required |
190196
191-
192197## Webhook installation
193198
194199Note: For a more detailed explanation, head over to the [ example-bot repository] [ example-bot-repository ] and follow the instructions there.
@@ -444,9 +449,9 @@ $telegram->enableExternalMySql($external_pdo_connection)
444449All methods implemented can be used to manage channels.
445450With [ admin commands] ( #admin-commands ) you can manage your channels directly with your bot private chat.
446451
447- ### Commands
452+ ## Commands
448453
449- #### Predefined Commands
454+ ### Predefined Commands
450455
451456The bot is able to recognise commands in a chat with multiple bots (/command@mybot).
452457
@@ -472,14 +477,14 @@ Here's the list:
472477 - Favourite colour? * /black, /red*
473478 - Favourite number? * /1, /134*
474479
475- #### Custom Commands
480+ ### Custom Commands
476481
477482Maybe you would like to develop your own commands.
478483There is a guide to help you [ create your own commands] [ wiki-create-your-own-commands ] .
479484
480485Also, be sure to have a look at the [ example commands] [ ExampleCommands-folder ] to learn more about custom commands and how they work.
481486
482- #### Commands Configuration
487+ ### Commands Configuration
483488
484489With this method you can set some command specific parameters, for example:
485490
@@ -548,7 +553,7 @@ $telegram->setCommandConfig('sendtochannel', [
548553```
549554- Enjoy!
550555
551- ### Upload and Download directory path
556+ ## Upload and Download directory path
552557
553558To use the Upload and Download functionality, you need to set the paths with:
554559``` php
@@ -580,7 +585,11 @@ If you like living on the edge, please report any bugs you find on the
580585
581586## Contributing
582587
583- See [ CONTRIBUTING] ( .github/CONTRIBUTING.md ) for more information.
588+ See [ CONTRIBUTING] ( CONTRIBUTING.md ) for more information.
589+
590+ ## Security
591+
592+ See [ SECURITY] ( SECURITY.md ) for more information.
584593
585594## Security
586595
@@ -599,7 +608,7 @@ Thank you for keeping this project alive :pray:
599608- [ ![ OpenCollective] ( https://user-images.githubusercontent.com/9423417/59235978-a561d500-8be3-11e9-89be-82ec54be1546.png ) OpenCollective.com/php-telegram-bot] [ OpenCollective ]
600609- [ ![ Ko-fi] ( https://user-images.githubusercontent.com/9423417/59235976-a561d500-8be3-11e9-911d-b1908c3e6a33.png ) Ko-fi.com/phptelegrambot] [ Ko-fi ]
601610- [ ![ Tidelift] ( https://user-images.githubusercontent.com/9423417/59235982-a6930200-8be3-11e9-8ac2-bfb6991d80c5.png ) Tidelift.com/longman/telegram-bot] [ Tidelift ]
602- - [ ![ Liberapay] ( https://user-images.githubusercontent.com/9423417/59235977-a561d500-8be3-11e9-9d16-bc3b13d3ceba.png ) Liberapay.com/PHP-Telegram-Bot] [ liberapay ]
611+ - [ ![ Liberapay] ( https://user-images.githubusercontent.com/9423417/59235977-a561d500-8be3-11e9-9d16-bc3b13d3ceba.png ) Liberapay.com/PHP-Telegram-Bot] [ Liberapay ]
603612- [ ![ PayPal] ( https://user-images.githubusercontent.com/9423417/59235981-a5fa6b80-8be3-11e9-9761-15eb7a524cb0.png ) PayPal.me/noplanman] [ PayPal-noplanman ] (account of @noplanman )
604613- [ ![ Bitcoin] ( https://user-images.githubusercontent.com/9423417/59235974-a4c93e80-8be3-11e9-9fde-260c821b6eae.png ) 166NcyE7nDxkRPWidWtG1rqrNJoD5oYNiV] [ Bitcoin ]
605614- [ ![ Ethereum] ( https://user-images.githubusercontent.com/9423417/59235975-a4c93e80-8be3-11e9-8762-7a47c62c968d.png ) 0x485855634fa212b0745375e593fAaf8321A81055] [ Ethereum ]
@@ -636,7 +645,7 @@ Credit list in [CREDITS](CREDITS)
636645[ OpenCollective ] : https://opencollective.com/php-telegram-bot " Support us on Open Collective "
637646[ Ko-fi ] : https://ko-fi.com/phptelegrambot " Support us on Ko-fi "
638647[ Tidelift ] : https://tidelift.com/subscription/pkg/packagist-longman-telegram-bot?utm_source=packagist-longman-telegram-bot&utm_medium=referral&utm_campaign=readme " Support us on Tidelift "
639- [ liberapay ] : https://liberapay.com/PHP-Telegram-Bot " Donate with Liberapay "
648+ [ Liberapay ] : https://liberapay.com/PHP-Telegram-Bot " Donate with Liberapay "
640649[ PayPal-noplanman ] : https://paypal.me/noplanman " Donate with PayPal "
641650[ Bitcoin ] : https://www.blockchain.com/btc/address/166NcyE7nDxkRPWidWtG1rqrNJoD5oYNiV " Donate with Bitcoin "
642651[ Ethereum ] : https://etherscan.io/address/0x485855634fa212b0745375e593fAaf8321A81055 " Donate with Ethereum "
0 commit comments