PHP Class Spatie\SlashCommand\Handlers\Help

Inheritance: extends SignatureHandler
Show file Open project: spatie/laravel-slack-slash-command

Protected Properties

Property Type Description
$description
$signature

Public Methods

Method Description
handle ( Request $request ) : Response Handle the given request.

Protected Methods

Method Description
displayHelpForCommand ( Collection $handlers, string $command ) : Response Show the help information for a single SignatureHandler.
displayListOfAllCommands ( Collection $handlers ) : Response Show a list of all available handlers.
findAvailableHandlers ( ) : Collection Find all handlers that are available for the current SlashCommand and have a signature.

Method Details

displayHelpForCommand() protected method

Show the help information for a single SignatureHandler.
protected displayHelpForCommand ( Collection $handlers, string $command ) : Response
$handlers Illuminate\Support\Collection
$command string
return Spatie\SlashCommand\Response

displayListOfAllCommands() protected method

Show a list of all available handlers.
protected displayListOfAllCommands ( Collection $handlers ) : Response
$handlers Illuminate\Support\Collection
return Spatie\SlashCommand\Response

findAvailableHandlers() protected method

Find all handlers that are available for the current SlashCommand and have a signature.
protected findAvailableHandlers ( ) : Collection
return Illuminate\Support\Collection

handle() public method

Handle the given request.
public handle ( Request $request ) : Response
$request Spatie\SlashCommand\Request
return Spatie\SlashCommand\Response

Property Details

$description protected property

protected $description

$signature protected property

protected $signature