DiscordPHP Documentation

Collections are containers for items that implement standard PHP interfaces, allowing them to behave like arrays. They are built around the concept of 'parts' and can be used for any data type.

Key behaviors include:

• Array Access: Use square bracket notation (e.g., $collec[123] = 'asdf';).
• Iteration: Use foreach loops to iterate over items.
• Serialization: Supports json_encode(), casting to (array), and casting to (string) (which performs a JSON encoding).

// square bracket index access
$collec[123] = 'asdf';
echo $collec[123]; // asdf

// foreach loops
foreach ($collec as $item) {
    // ...
}

// json serialization
json_encode($collec);

// array serialization
$collecArray = (array) $collec;

// string serialization
$jsonCollec = (string) $collec; // same as json_encode($collec)

Events are payloads sent over the WebSocket that correspond to real-time occurrences in Discord. To respond to these events in your application, use the event emitter callback mechanism provided by the library along with the Event name constants.

Note that some events are handled internally by the library and might not trigger a registered listener. These include:

• Event::READY
• Event::RESUMED
• Event::GUILD_MEMBERS_CHUNK

If you need to intercept these internal events, you must parse the 'raw' dispatch event data directly.

A Member object represents a specific user within a specific guild (server). Because a user can belong to multiple guilds, there will be a unique Member object for every guild-user relationship.

Note: A Member object can be serialized into a Discord mention string (e.g., <@member_id>) by using it in a string context. However, $message->member may be null if the message is a Direct Message (DM) or if the member object was not cached by the library.

$discord->on(Event::MESSAGE_CREATE, function (Message $message) {
    // Hello <@member_id>!
    // Note: `$message->member` will be `null` if the message originated from
    // a private message, or if the member object was not cached.
    $message->channel->sendMessage('Hello '.$message->member.'!');
});

DiscordPHP is designed to run in CLI (Command Line Interface) environments only. It cannot be run directly on a webserver (e.g., Apache or Nginx).

If you need to provide a web interface for your bot, you should integrate react/http and run the entire process through the CLI.

An ActionRow represents a row of buttons on a message. You cannot attach buttons directly to a message; they must be contained within an ActionRow. Each row can hold up to 5 buttons. Use addComponent($component) to add a button to the row.

$row = ActionRow::new()
    ->addComponent(Button::new(Button::STYLE_SUCCESS));

In DiscordPHP, 'Parts' are the data structures representing Discord entities (such as Guild, Channel, Member, Message, and User). All parts share a common set of attributes and methods.

Parts have a predefined list of 'fillable' fields. If you attempt to set a field that is not in the fillable list, the operation will fail silently without a warning.

A Member object represents a specific user within a specific guild (server). Because a single user can belong to multiple guilds, there will be a unique Member object for every guild-user relationship.

Important Note: When accessing $message->member, it may be null if the message originated from a private message (DM) or if the member object was not present in the local cache.

$discord->on(Event::MESSAGE_CREATE, function (Message $message) {
    // Note: `$message->member` will be `null` if the message originated from
    // a private message, or if the member object was not cached.
    // A member object can be serialized into a mention string (e.g., <@member_id>).
    $message->channel->sendMessage('Hello '.$message->member.'!');
});

In DiscordPHP, Repositories act as containers for Parts. They provide the interface to get, save, and delete specific data types (Parts) from Discord servers.

Each Part type has multiple repositories associated with it. For example, the Channel part has four distinct repositories:

• members: Members currently in a voice channel.
• messages: Messages sent in the channel.
• overwrites: Channel permission overwrites.
• webhooks: Webhooks associated with the channel.

Repositories extend the Collection class, meaning they inherit all collection-related methods.

DiscordPHP handles permissions through two distinct types of classes: Channel Permissions and Role Permissions. While they represent different scopes of authority, both extend the same abstract permission class.

• Channel Permissions: Govern what a user can do within specific channel types (Text, Voice, or Stage Instance).
• Role Permissions: Govern what a user can do within a Guild (Server) based on their assigned roles.

Repositories act as containers for specific 'parts' of Discord data. They provide the interface to get, save, and delete these parts from Discord servers.

Each major Discord entity (a 'Part') has multiple repositories associated with it. For example, a Channel part has four repositories:

• members: Members currently in a voice channel.
• messages: Messages sent in the channel.
• overwrites: Permission overwrites for the channel.
• webhooks: Webhooks associated with the channel.

All repositories extend the Collection class, meaning they inherit all collection-related methods.