PHP Класс Telegram\Bot\Commands\CommandBus

Показать файл Открыть проект

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

Свойство Тип Описание
$commandAliases Holds all commands' aliases.
$commands Holds all commands.

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

Метод Описание
__construct ( Api $telegram ) Instantiate Command Bus.
addCommand ( Telegram\Bot\Commands\CommandInterface | string $command ) : CommandBus Add a command to the commands list.
addCommands ( array $commands ) : CommandBus Add a list of commands.
getCommands ( ) : array Returns the list of commands.
parseCommand ( $text ) : array Parse a Command for a Match.
removeCommand ( $name ) : CommandBus Remove a command from the list.
removeCommands ( array $names ) : CommandBus Removes a list of commands.

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

Метод Описание
execute ( $name, $arguments, $message ) : mixed Execute the command.
handler ( $message, Update $update ) : Update Handles Inbound Messages and Executes Appropriate Command.

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

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

Instantiate Command Bus.
public __construct ( Api $telegram )
$telegram Telegram\Bot\Api

addCommand() публичный Метод

Add a command to the commands list.
public addCommand ( Telegram\Bot\Commands\CommandInterface | string $command ) : CommandBus
$command Telegram\Bot\Commands\CommandInterface | string Either an object or full path to the command class.
Результат CommandBus

addCommands() публичный Метод

Add a list of commands.
public addCommands ( array $commands ) : CommandBus
$commands array
Результат CommandBus

execute() защищенный Метод

Execute the command.
protected execute ( $name, $arguments, $message ) : mixed
$name
$arguments
$message
Результат mixed

getCommands() публичный Метод

Returns the list of commands.
public getCommands ( ) : array
Результат array

handler() защищенный Метод

Handles Inbound Messages and Executes Appropriate Command.
protected handler ( $message, Update $update ) : Update
$message
$update Telegram\Bot\Objects\Update
Результат Telegram\Bot\Objects\Update

parseCommand() публичный Метод

Parse a Command for a Match.
public parseCommand ( $text ) : array
$text
Результат array

removeCommand() публичный Метод

Remove a command from the list.
public removeCommand ( $name ) : CommandBus
$name
Результат CommandBus

removeCommands() публичный Метод

Removes a list of commands.
public removeCommands ( array $names ) : CommandBus
$names array
Результат CommandBus

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

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

Holds all commands' aliases.
protected $commandAliases

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

Holds all commands.
protected $commands