Discord

Discord is the main object of your Discord BOT Application

Methods

__construct()

Creates a Discord client instance.

function __construct([array<string|int, mixed> $options = [] ]) : mixed

Return

• Discord the bot instance

Example

$discord = new Discord([
    'token' => 'bot-token',
]);

close()

Closes the Discord client.

function close([bool $closeLoop = true ]) : void

Example

$discord->close();

factory()

Allows access to the part/repository factory.

function factory(string $class[, mixed $data = [] ][, bool $created = false ]) : Part|AbstractRepository

The use of factory with part is possible with the new Part($discord, $data, $created); Return

• Part the bot Part Factory
• Repository the bot Repository Factory

Example

// Preferred way
$channel = new Channel($discord, ['name' = 'newchannel']);
// Is equivalent to:
$channel = $discord->factory(Channel::class, ['name' => 'newchannel']);

getChannel()

Gets a channel.

function getChannel(string|int $channel_id) : Channel|null

Return

• Channel the channel or private channel part

Example

$channel = $discord->getChannel('012345678910111213');

getFactory()

Gets the factory.

function getFactory() : Factory

Return

• Factory the bot Factory object

Example

$factory = $discord->getFactory();

getHttpClient()

Gets the HTTP client.

function getHttpClient() : Http

Return

• Http the bot Http object

Example

$httpClient = $discord->getHttpClient();

getLogger()

Gets the logger being used.

function getLogger() : LoggerInterface

Return

• LoggerInterface the Logger interface

Example

$logger = $discord->getLogger();

getLoop()

Gets the loop being used by the bot client.

function getLoop() : LoopInterface

Return

• LoopInterface the bot Loop interface

Example

$loop = $discord->getLoop();

getVoiceClient()

Gets the bot voice client from a guild ID. Returns null if there is no voice client.

function getVoiceClient(string $guild_id) : VoiceClient|null

Return

• VoiceClient the bot Voice Client
• null the bot has no Voice Client

Example

$voiceClient = $discord->getVoiceClient('012345678910111213');

joinVoiceChannel()

Joins a voice channel.

function joinVoiceChannel(Channel $channel[, bool $mute = false ][, bool $deaf = true ][, LoggerInterface|null $logger = null ][, bool $check = true ]) : PromiseInterface

Return

• PromiseInterface the promise when bot has joined the voice channel

Example

$discord->joinVoiceChannel($channel)->then(function (VoiceClient $vc) {
    echo "Joined voice channel.\r\n";
    $vc->playFile('myfile.mp3');
}, function ($e) {
    echo "There was an error joining the voice channel: {$e->getMessage()}\r\n"; 
});

run()

Starts the ReactPHP event loop.

function run() : void

Example

// Should be placed at bottom of the script
$discord->run();

updatePresence()

Updates the clients presence.

function updatePresence([Activity|null $activity = null ][, bool $idle = false ][, string $status = 'online' ][, bool $afk = false ]) : void

See Activity

API Documentation: https://discord.com/developers/docs/topics/gateway#update-presence

Example

$activity = new Activity($discord, [
    'name' => 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
    'type' => Activity::TYPE_WATCHING
]);

$discord->updatePresence($activity);

Events

To handle various events from Discord, you can use $discord->on(EVENTNAME, CALLBACK);

ready

This event is called when the Discord BOT is ready (connected online).

const READY = 'READY' 

Gateway events should be registered inside the ready event, which is emitted once when the bot first starts and has connected to the gateway.

Example

$discord->on('ready', function ($discord) {
    echo "Bot is ready.", PHP_EOL;
});