• Главная
• Longman
• TelegramBot
• Telegram

PHP Класс Longman\TelegramBot\Telegram

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$admins_list	array	Admins list
$api_key	string	Telegram API key
$bot_name	string	Telegram Bot name
$botan_enabled	boolean	Botan.io integration
$commands_config	array	Commands config
$commands_paths	array	Custom commands paths
$download_path	string	Download path
$input	string	Raw request data (json) for webhook methods
$last_command_response	Longman\TelegramBot\Entities\ServerResponse	ServerResponse of the last Command execution
$mysql_enabled	boolean	MySQL integration
$pdo	PDO	PDO object
$update	Longman\TelegramBot\Entities\Update	Current Update object
$upload_path	string	Upload path
$version	string	Version

Открытые методы

Метод	Описание
__construct ( string $api_key, string $bot_name )	Telegram constructor.
addCommandsPath ( string $path, boolean $before = true ) : Telegram	Add a single custom commands path
addCommandsPaths ( array $paths, boolean $before = true ) : Telegram	Add multiple custom commands paths
enableAdmin ( integer $admin_id ) : Telegram	Enable a single Admin account
enableAdmins ( array $admin_ids ) : Telegram	Enable a list of Admin Accounts
enableBotan ( $token ) : Telegram	Enable Botan.io integration
enableExternalMySql ( PD\PDO $external_pdo_connection, string $table_prefix = null ) : Telegram	Initialize Database external connection
enableMySql ( array $credential, string $table_prefix = null, string $encoding = 'utf8mb4' ) : Telegram	Initialize Database connection
executeCommand ( string $command ) : mixed	Execute /command
getAdminList ( ) : array	Get list of admins
getApiKey ( ) : string	Get API key
getBotName ( ) : string	Get Bot name
getCommandConfig ( string $command ) : array	Get command config
getCommandObject ( string $command ) : Command | null	Get an object instance of the passed command
getCommandsList ( ) : array	Get commands list
getCustomInput ( ) : string	Get custom input string for debug purposes
getDownloadPath ( ) : string	Get custom download path
getLastCommandResponse ( ) : ServerResponse	Get the ServerResponse of the last Command execution
getUploadPath ( ) : string	Get custom upload path
getVersion ( ) : string	Get Version
handle ( ) : boolean	Handle bot request from webhook
handleGetUpdates ( integer | null $limit = null, integer | null $timeout = null ) : ServerResponse	Handle getUpdates method
isAdmin ( integer | null $user_id = null ) : boolean	Check if the passed user is an admin
isDbEnabled ( ) : boolean	Check if user required the db connection
processUpdate ( Update $update ) : ServerResponse	Process bot Update request
setCommandConfig ( string $command, array $config ) : Telegram	Set command config
setCustomInput ( string $input ) : Telegram	Set custom input string for debug purposes
setDownloadPath ( string $path ) : Telegram	Set custom download path
setUploadPath ( string $path ) : Telegram	Set custom upload path
setWebHook ( string $url, string | null $path_certificate = null ) : ServerResponse	Set Webhook for bot
unsetWebHook ( ) : mixed	Unset Webhook for bot

Защищенные методы

Метод	Описание
sanitizeCommand ( string $command ) : string	Sanitize Command
ucfirstUnicode ( string $str, string $encoding = 'UTF-8' ) : string	Replace function ucfirst for UTF-8 characters in the class definition and commands
ucwordsUnicode ( string $str, string $encoding = 'UTF-8' ) : string	Replace function ucwords for UTF-8 characters in the class definition and commands

Приватные методы

Метод	Описание
getCommandFromType ( string $type ) : string	Get the command name from the command type

Описание методов

Описание свойств