PHP 클래스 Longman\TelegramBot\Commands\Command

파일 보기 프로젝트 열기: akalongman/php-telegram-bot 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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