PHP Class Longman\TelegramBot\Commands\Command

Afficher le fichier Open project: akalongman/php-telegram-bot Class Usage Examples

Protected Properties

Свойство Type Description
$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

Méthodes publiques

Méthode Description
__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

Method Details

__construct() public méthode

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

execute() abstract public méthode

Execute command
abstract public execute ( ) : ServerResponse
Résultat Longman\TelegramBot\Entities\ServerResponse

executeNoDb() public méthode

Execution if MySQL is required but not available
public executeNoDb ( ) : ServerResponse
Résultat Longman\TelegramBot\Entities\ServerResponse

getConfig() public méthode

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
Résultat array | mixed | null

getDescription() public méthode

Get description
public getDescription ( ) : string
Résultat string

getMessage() public méthode

Get message object
public getMessage ( ) : Message
Résultat Longman\TelegramBot\Entities\Message

getName() public méthode

Get name
public getName ( ) : string
Résultat string

getTelegram() public méthode

Get telegram object
public getTelegram ( ) : Telegram
Résultat Longman\TelegramBot\Telegram

getUpdate() public méthode

Get update object
public getUpdate ( ) : Update
Résultat Longman\TelegramBot\Entities\Update

getUsage() public méthode

Get usage
public getUsage ( ) : string
Résultat string

getVersion() public méthode

Get version
public getVersion ( ) : string
Résultat string

isAdminCommand() public méthode

If this is an AdminCommand
public isAdminCommand ( ) : boolean
Résultat boolean

isEnabled() public méthode

Check if command is enabled
public isEnabled ( ) : boolean
Résultat boolean

isSystemCommand() public méthode

If this is a SystemCommand
public isSystemCommand ( ) : boolean
Résultat boolean

isUserCommand() public méthode

If this is a UserCommand
public isUserCommand ( ) : boolean
Résultat boolean

preExecute() public méthode

Pre-execute command
public preExecute ( ) : ServerResponse
Résultat Longman\TelegramBot\Entities\ServerResponse

setUpdate() public méthode

Set update object
public setUpdate ( Update $update = null ) : Command
$update Longman\TelegramBot\Entities\Update
Résultat Command

Property Details

$config protected_oe property

Command config
protected array $config
Résultat array

$description protected_oe property

Description
protected string $description
Résultat string

$enabled protected_oe property

If this command is enabled
protected bool $enabled
Résultat boolean

$message protected_oe property

Message object
protected Message,Longman\TelegramBot\Entities $message
Résultat Longman\TelegramBot\Entities\Message

$name protected_oe property

Name
protected string $name
Résultat string

$need_mysql protected_oe property

If this command needs mysql
protected bool $need_mysql
Résultat boolean

$telegram protected_oe property

Telegram object
protected Telegram,Longman\TelegramBot $telegram
Résultat Longman\TelegramBot\Telegram

$update protected_oe property

Update object
protected Update,Longman\TelegramBot\Entities $update
Résultat Longman\TelegramBot\Entities\Update

$usage protected_oe property

Usage
protected string $usage
Résultat string

$version protected_oe property

Version
protected string $version
Résultat string