DiscordPHP-MTG Documentation

Sets
in package
implements Module uses InteractionTrait

FinalYes

Sets: `/set show` and `/set search`.

A set answers with what it is, its size and boosters, and buttons to browse its cards (pages from the Cards module), open a booster (Boosters module) and list its decks (Decks module). The card view's Set button lands here too (set:show:<code>).

Tags
since
1.1.0

Table of Contents

Interfaces

Module
A self-contained bot feature, as in Tutelar: it declares its own application commands ({@see commands()}, which the client registers or updates), listens for them, and routes clicks on the components of the messages it sends, from {@see boot()}.

Methods

boot()  : void
Registers commands and listeners. Called once, after the gateway and the application are ready.
commands()  : array<string|int, CommandBuilder>
The application commands the module answers, as they should be registered. The client creates missing ones and updates changed ones.
name()  : string
Stable short name, for logs.
view()  : PromiseInterface<string|int, MessageBuilder>
A set's view, with its boosters and deck count.
answer()  : PromiseInterface
Answers a component click with a new message, or by replacing the clicked message, logging what fails.
choices()  : array<string|int, array{name: string, value: string}>
Autocomplete choices from `value => label` (or a list of values).
command()  : CommandBuilder
A chat command usable in servers, the bot's DMs and group DMs, from a server install or a user install.
failure()  : MessageBuilder
The message for a failure.
hidden()  : Option
The `hidden` option every command takes: reply only to the caller.
option()  : Option
A command option.
reply()  : PromiseInterface
Defers the reply, then answers with what `$work` resolves to. A failure answers too: a bad search is the caller's to fix, anything else is logged.
subcommand()  : Option
A sub-command with its options.
typed()  : array<string, mixed>
The values typed so far into the command being autocompleted, from inside its sub-command.
values()  : array<string, mixed>
Option values by name.
cards()  : PromiseInterface<string|int, MessageBuilder>
The first page of a set's cards, in collector number order.
page()  : PromiseInterface<string|int, MessageBuilder>
A page of a set search.
search()  : PromiseInterface
`/set search`.
show()  : PromiseInterface
`/set show`.

Methods

boot()

Registers commands and listeners. Called once, after the gateway and the application are ready.

public boot(MTG $mtg) : void
Parameters
$mtg : MTG
Tags
inheritDoc

commands()

The application commands the module answers, as they should be registered. The client creates missing ones and updates changed ones.

public commands(MTG $mtg) : array<string|int, CommandBuilder>
Parameters
$mtg : MTG
Tags
inheritDoc
Return values
array<string|int, CommandBuilder>

name()

Stable short name, for logs.

public name() : string
Tags
inheritDoc
Return values
string

view()

A set's view, with its boosters and deck count.

public static view(MTG $mtg, string $code) : PromiseInterface<string|int, MessageBuilder>
Parameters
$mtg : MTG
$code : string
Return values
PromiseInterface<string|int, MessageBuilder>

answer()

Answers a component click with a new message, or by replacing the clicked message, logging what fails.

protected static answer(MTG $mtg, Interaction $interaction, callable $work[, bool $update = false ]) : PromiseInterface
Parameters
$mtg : MTG
$interaction : Interaction
$work : callable

Returns a MessageBuilder or a promise of one.

$update : bool = false

Replace the clicked message instead of answering with a new, hidden one.

Return values
PromiseInterface

choices()

Autocomplete choices from `value => label` (or a list of values).

protected static choices(array<string|int, mixed> $choices) : array<string|int, array{name: string, value: string}>
Parameters
$choices : array<string|int, mixed>
Return values
array<string|int, array{name: string, value: string}>

command()

A chat command usable in servers, the bot's DMs and group DMs, from a server install or a user install.

protected static command(string $name, string $description) : CommandBuilder
Parameters
$name : string
$description : string
Return values
CommandBuilder

failure()

The message for a failure.

protected static failure(MTG $mtg, Throwable $e) : MessageBuilder
Parameters
$mtg : MTG
$e : Throwable
Return values
MessageBuilder

hidden()

The `hidden` option every command takes: reply only to the caller.

protected static hidden(MTG $mtg) : Option
Parameters
$mtg : MTG
Return values
Option

option()

A command option.

protected static option(MTG $mtg, int $type, string $name, string $description[, bool $required = false ][, bool $autocomplete = false ]) : Option
Parameters
$mtg : MTG
$type : int

An Option type constant.

$name : string
$description : string
$required : bool = false
$autocomplete : bool = false
Return values
Option

reply()

Defers the reply, then answers with what `$work` resolves to. A failure answers too: a bad search is the caller's to fix, anything else is logged.

protected static reply(MTG $mtg, Interaction $interaction, bool $hidden, callable $work) : PromiseInterface
Parameters
$mtg : MTG
$interaction : Interaction
$hidden : bool

Whether only the caller sees the answer.

$work : callable

Returns a MessageBuilder or a promise of one.

Return values
PromiseInterface

subcommand()

A sub-command with its options.

protected static subcommand(MTG $mtg, string $name, string $description, Option ...$options) : Option
Parameters
$mtg : MTG
$name : string
$description : string
$options : Option
Return values
Option

typed()

The values typed so far into the command being autocompleted, from inside its sub-command.

protected static typed(Interaction $interaction) : array<string, mixed>
Parameters
$interaction : Interaction
Return values
array<string, mixed>

values()

Option values by name.

protected static values(iterable<string|int, mixed> $options) : array<string, mixed>
Parameters
$options : iterable<string|int, mixed>

The options a command handler is given.

Return values
array<string, mixed>

cards()

The first page of a set's cards, in collector number order.

private static cards(MTG $mtg, string $code) : PromiseInterface<string|int, MessageBuilder>
Parameters
$mtg : MTG
$code : string
Return values
PromiseInterface<string|int, MessageBuilder>

page()

A page of a set search.

private static page(MTG $mtg, string $search, int $page) : PromiseInterface<string|int, MessageBuilder>
Parameters
$mtg : MTG
$search : string
$page : int
Return values
PromiseInterface<string|int, MessageBuilder>

search()

`/set search`.

private search(MTG $mtg, Interaction $interaction, array<string|int, mixed> $args) : PromiseInterface
Parameters
$mtg : MTG
$interaction : Interaction
$args : array<string|int, mixed>
Return values
PromiseInterface

show()

`/set show`.

private show(MTG $mtg, Interaction $interaction, array<string|int, mixed> $args) : PromiseInterface
Parameters
$mtg : MTG
$interaction : Interaction
$args : array<string|int, mixed>
Return values
PromiseInterface
On this page

Search results