PHP Класс Longman\TelegramBot\Commands\Command

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

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

Свойство Тип Описание
$config array Command config
$description string Description
$enabled boolean If this command is enabled
$message Longman\TelegramBot\Entities\Message Message object
$name string Name
$need_mysql boolean If this command needs mysql
$telegram Longman\TelegramBot\Telegram Telegram object
$update Longman\TelegramBot\Entities\Update Update object
$usage string Usage
$version string Version

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

Метод Описание
__construct ( Telegram $telegram, Update $update = null ) Constructor
execute ( ) : ServerResponse Execute command
executeNoDb ( ) : ServerResponse Execution if MySQL is required but not available
getConfig ( string | null $name = null ) : array | mixed | null Get command config
getDescription ( ) : string Get description
getMessage ( ) : Message Get message object
getName ( ) : string Get name
getTelegram ( ) : Telegram Get telegram object
getUpdate ( ) : Update Get update object
getUsage ( ) : string Get usage
getVersion ( ) : string Get version
isAdminCommand ( ) : boolean If this is an AdminCommand
isEnabled ( ) : boolean Check if command is enabled
isSystemCommand ( ) : boolean If this is a SystemCommand
isUserCommand ( ) : boolean If this is a UserCommand
preExecute ( ) : ServerResponse Pre-execute command
setUpdate ( Update $update = null ) : Command Set update object

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

__construct() публичный метод

Constructor
public __construct ( Telegram $telegram, Update $update = null )
$telegram Longman\TelegramBot\Telegram
$update Longman\TelegramBot\Entities\Update

execute() абстрактный публичный метод

Execute command
abstract public execute ( ) : ServerResponse
Результат Longman\TelegramBot\Entities\ServerResponse

executeNoDb() публичный метод

Execution if MySQL is required but not available
public executeNoDb ( ) : ServerResponse
Результат Longman\TelegramBot\Entities\ServerResponse

getConfig() публичный метод

Look for config $name if found return it, if not return null. If $name is not set return all set config.
public getConfig ( string | null $name = null ) : array | mixed | null
$name string | null
Результат array | mixed | null

getDescription() публичный метод

Get description
public getDescription ( ) : string
Результат string

getMessage() публичный метод

Get message object
public getMessage ( ) : Message
Результат Longman\TelegramBot\Entities\Message

getName() публичный метод

Get name
public getName ( ) : string
Результат string

getTelegram() публичный метод

Get telegram object
public getTelegram ( ) : Telegram
Результат Longman\TelegramBot\Telegram

getUpdate() публичный метод

Get update object
public getUpdate ( ) : Update
Результат Longman\TelegramBot\Entities\Update

getUsage() публичный метод

Get usage
public getUsage ( ) : string
Результат string

getVersion() публичный метод

Get version
public getVersion ( ) : string
Результат string

isAdminCommand() публичный метод

If this is an AdminCommand
public isAdminCommand ( ) : boolean
Результат boolean

isEnabled() публичный метод

Check if command is enabled
public isEnabled ( ) : boolean
Результат boolean

isSystemCommand() публичный метод

If this is a SystemCommand
public isSystemCommand ( ) : boolean
Результат boolean

isUserCommand() публичный метод

If this is a UserCommand
public isUserCommand ( ) : boolean
Результат boolean

preExecute() публичный метод

Pre-execute command
public preExecute ( ) : ServerResponse
Результат Longman\TelegramBot\Entities\ServerResponse

setUpdate() публичный метод

Set update object
public setUpdate ( Update $update = null ) : Command
$update Longman\TelegramBot\Entities\Update
Результат Command

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

$config защищенное свойство

Command config
protected array $config
Результат array

$description защищенное свойство

Description
protected string $description
Результат string

$enabled защищенное свойство

If this command is enabled
protected bool $enabled
Результат boolean

$message защищенное свойство

Message object
protected Message,Longman\TelegramBot\Entities $message
Результат Longman\TelegramBot\Entities\Message

$name защищенное свойство

Name
protected string $name
Результат string

$need_mysql защищенное свойство

If this command needs mysql
protected bool $need_mysql
Результат boolean

$telegram защищенное свойство

Telegram object
protected Telegram,Longman\TelegramBot $telegram
Результат Longman\TelegramBot\Telegram

$update защищенное свойство

Update object
protected Update,Longman\TelegramBot\Entities $update
Результат Longman\TelegramBot\Entities\Update

$usage защищенное свойство

Usage
protected string $usage
Результат string

$version защищенное свойство

Version
protected string $version
Результат string