Minor Revamp

* Renamed `newPartDiscord` to `newDiscordPart`
* Added `getDiscord`
* Removed `createLocalFileAttachment`
* Added `index.php` to files that are sniffed
* Renamed `init` event class to `Init`
* Helper Function docs are now generated

Author: CommandString

.gitignore

@@ -2,3 +2,4 @@
 env.json
 .idea/
 .vscode/
+tools/HelperDocs.md

Commands/Guild.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Commands;
+
+use Discord\Builders\CommandBuilder;
+use Discord\Builders\Components\Button;
+use Discord\Builders\MessageBuilder;
+use Discord\Parts\Embed\Embed;
+use Discord\Parts\Interactions\Interaction;
+use Discord\Parts\User\User;
+use Throwable;
+
+use function Common\buildActionRowWithButtons;
+use function Common\emptyEmbedField;
+use function Common\getDiscord;
+use function Common\newButton;
+use function Common\newDiscordPart;
+use function React\Async\await;
+
+class Guild extends BaseCommand
+{
+    public const VIEW_EMOJIS = 1;
+    public const VIEW_ICON = 2;
+
+    protected static array|string $name = 'guild';
+
+    public static function handler(Interaction $interaction): void
+    {
+        /** @var Embed $embed */
+        /** @var User $owner */
+        $guild = $interaction->guild;
+        $embed = newDiscordPart(Embed::class);
+        $msg = new MessageBuilder;
+
+
+        if ($owner = $guild->owner) {
+            $embed->addFieldValues('Owner', $owner);
+        }
+
+        $embed
+            ->setAuthor($guild->name, $guild->icon, $guild->invites->first())
+            ->setDescription($guild->description ?? "")
+            ->addFieldValues('Member Count', $guild->member_count, true)
+            ->addFieldValues('Channel Count', $guild->channels->count(), true)
+            ->addFieldValues("Emoji Count", $guild->emojis->count(), true)
+            ->addFieldValues("Snowflake", "`{$guild->id}`", true)
+
+            ->setFooter("Created ")
+            ->setTimestamp($guild->createdTimestamp())
+        ;
+        $msg->addEmbed($embed);
+
+        $newButton = fn(string $action, string $actionId) => newButton(Button::STYLE_PRIMARY, $action, "GuildInfo|{$actionId}");
+
+        $msg->addComponent(
+            buildActionRowWithButtons(
+                $newButton("View Icon", self::VIEW_ICON),
+                $newButton("View Emojis", self::VIEW_EMOJIS),
+            )
+        );
+
+        $interaction->respondWithMessage($msg);
+    }
+
+    public static function autocomplete(Interaction $interaction): void
+    {
+    }
+
+    public static function getConfig(): CommandBuilder|array
+    {
+        return (new CommandBuilder())
+            ->setName(self::getBaseCommandName())
+            ->setDescription('Get info about the current guild')
+        ;
+    }
+}

Commands/Ping.php

@@ -3,33 +3,17 @@
 namespace Commands;
 
 use Discord\Builders\CommandBuilder;
-use Discord\Builders\Components\ActionRow;
-use Discord\Builders\Components\Button;
-use Discord\Builders\MessageBuilder;
 use Discord\Parts\Interactions\Interaction;
 
-use function Common\newButton;
-use function Common\buildActionRowWithButtons;
+use function Common\messageWithContent;
 
 class Ping extends BaseCommand
 {
     protected static string|array $name = "ping";
 
     public static function handler(Interaction $interaction): void
     {
-        $interaction->respondWithMessage(MessageBuilder::new()
-            ->setContent('Pong :ping_pong:')
-            ->addComponent(self::getActionRow(0, false)), true)
-        ;
-    }
-
-    public static function getActionRow(int $times, bool $ping): ActionRow
-    {
-        $button = ($ping) ?
-        newButton(Button::STYLE_PRIMARY, "Ping", "Ping|{$times}") :
-        newButton(Button::STYLE_SECONDARY, "Pong", "Pong|{$times}");
-
-        return buildActionRowWithButtons($button);
+        $interaction->respondWithMessage(messageWithContent("Ping :ping_pong:"), true);
     }
 
     public static function getConfig(): CommandBuilder|array

Common/Helpers.php

@@ -6,49 +6,79 @@
 use Discord\Builders\Components\ActionRow;
 use Discord\Builders\Components\Button;
 use Discord\Builders\MessageBuilder;
+use Discord\Discord;
 use Discord\Helpers\Collection;
-use Discord\Parts\Channel\Attachment;
 use Discord\Parts\Embed\Embed;
 use Discord\Parts\Interactions\Command\Choice;
 use Discord\Parts\Interactions\Command\Option;
 use Discord\Parts\Interactions\Interaction;
-use Discord\Parts\Interactions\Request\Option as RequestOption;
 
-function newOption(string $name, string $description, int $type, bool $required = false): Option
+/**
+ * Create a new Option used for building slash commands
+ */
+function newSlashCommandOption(string $name, string $description, int $type, bool $required = false): Option
 {
-    return newPartDiscord(Option::class)
+    return newDiscordPart(Option::class)
         ->setName($name)
         ->setDescription($description)
         ->setType($type)
         ->setRequired($required)
     ;
 }
 
-function newChoice(string $name, float|int|string $value): Choice
+/**
+ * Create a new Choice used for building slash commands
+ */
+function newSlashCommandChoice(string $name, float|int|string $value): Choice
 {
-    return newPartDiscord(Choice::class)
+    return newDiscordPart(Choice::class)
         ->setName($name)
         ->setValue($value)
     ;
 }
 
-function newPartDiscord(string $class, mixed ...$args): mixed
+/**
+ * Create a new instance of an object that requires `\Discord\Discord` as the first argument
+ *
+ * ```php
+ * $embed = newDiscordPart("\Discord\Parts\Embed\Embed);
+ * ```
+ */
+function newDiscordPart(string $class, mixed ...$args): mixed
 {
     return (new $class(Env::get()->discord, ...$args));
 }
 
+/**
+ * Create a new MessageBuilder object with the content define for creating simple MessageBuilders quickly
+ *
+ * ```php
+ * $message = messageWithContent("Hello World");
+ * ```
+ */
 function messageWithContent(string $content): MessageBuilder
 {
     return MessageBuilder::new()->setContent($content);
 }
 
-function createLocalFileAttachment(string $fileName): Attachment
-{
-    return new Attachment(Env::get()->discord, [
-        "filename" => $fileName
-    ]);
-}
-
+/**
+ * Quickly build an action row with multiple buttons
+ *
+ * ```php
+ * $banButton = (new Button(Button::STYLE_DANGER))->setLabel("Ban User");
+ * $kickButton = (new Button(Button::STYLE_DANGER))->setLabel("Kick User");
+ * $actionRow = buildActionRowWithButtons($banButton, $kickButton);
+ * ```
+ *
+ * *This can also be paired with newButton*
+ *
+ * ```php
+ * $actionRow = buildActionWithButtons(
+ *  newButton(Button::STYLE_DANGER, "Ban User")
+ *  newButton(Button::STYLE_DANGER, "Kick User")
+ * );
+ * ```
+ */
 function buildActionRowWithButtons(Button ...$buttons): ActionRow
 {
     $actionRow = new ActionRow();
@@ -60,12 +90,36 @@ function buildActionRowWithButtons(Button ...$buttons): ActionRow
     return $actionRow;
 }
 
+/**
+ * Quickly create button objects
+ *
+ * ```php
+ * $button = newButton(Button::STYLE_DANGER, "Kick User", "Kick|Command_String");
+ * ```
+ */
 function newButton(int $style, string $label, ?string $custom_id = null): Button
 {
     return (new Button($style, $custom_id))->setLabel($label);
 }
 
-function getOptionFromInteraction(Collection|Interaction $options, string ...$names): ?RequestOption
+/**
+ * Get an option from an Interaction/Interaction Repository by specifying the option(s) name
+ *
+ * For regular slash commands
+ * `/ban :user`
+ *
+ * ```php
+ * $user = getOptionFromInteraction($interaction, "user");
+ * ```
+ *
+ * For sub commands / sub command groups you can stack the names
+ * `/admin ban :user`
+ *
+ * ```php
+ * $user = getOptionFromInteraction($interaction->data->options, "ban", "user");
+ * ```
+ */
+function getOptionFromInteraction(Collection|Interaction $options, string ...$names): Option|null
 {
     if ($options instanceof Interaction) {
         $options = $options->data->options;
@@ -87,6 +141,22 @@ function getOptionFromInteraction(Collection|Interaction $options, string ...$na
     return $option;
 }
 
+/**
+ * Append to grab and empty array field. You can supply an embed to have the empty field added or
+ * if you leave the `$embed` option `null` then an array containing the empty field will be returned
+ *
+ * ```php
+ * $embed = newDiscordPart("\Discord\Parts\Embed\Embed");
+ * emptyEmbedField($embed);
+ * ```
+ *
+ * or
+ *
+ * ```php
+ * $embed = newDiscordPart("\Discord\Parts\Embed\Embed");
+ * $emptyField = emptyEmbedField();
+ * ```
+ */
 function emptyEmbedField(?Embed $embed = null): array|Embed
 {
     $emptyField = ["name" => "\u{200b}", "value" => "\u{200b}"];
@@ -97,3 +167,11 @@ function emptyEmbedField(?Embed $embed = null): array|Embed
 
     return $emptyField;
 }
+
+/**
+ * Retrieve the `\Discord\Discord` instance from Environment
+ */
+function getDiscord(): Discord
+{
+    return Env::get()->discord;
+}

Interactions/GuildInfo.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Interactions;
+
+use Commands\Guild as GuildCommand;
+use Discord\Builders\MessageBuilder;
+use Discord\Parts\Interactions\Interaction;
+use Discord\Discord;
+use Discord\Parts\Embed\Embed;
+use Discord\Parts\Guild\Emoji;
+
+use function Common\messageWithContent;
+use function Common\newDiscordPart;
+
+class GuildInfo extends BaseInteraction
+{
+    protected static string $id = "GuildInfo";
+
+    public static function handler(Interaction $interaction, Discord $discord, int $actionId = 0)
+    {   
+        /** @var Embed $embed */
+        if ($actionId < 1 || $actionId > 2) {
+            $interaction->respondWithMessage(messageWithContent("Invalid Action"), true);
+            return;
+        }
+
+        $msg = new MessageBuilder;
+        $embed = newDiscordPart(Embed::class);
+        $guild = $interaction->guild;
+        
+        $embed->setAuthor($guild->name, $guild->icon, $guild->invites->first());
+
+        if ($actionId === GuildCommand::VIEW_EMOJIS) {
+            /** @var Emoji $emoji */
+            $emojis = $guild->emojis;
+
+            $emojiString = "";
+
+            foreach ($emojis as $emoji) {
+                $emojiString .= "`{$emoji}` {$emoji}\n";
+            }
+
+            $embed->setTitle("{$guild->name} Emojis")->setDescription($emojiString);
+        } else if ($actionId === GuildCommand::VIEW_ICON) {
+            $embed->setTitle("{$guild->name} Icon")->setImage($guild->icon);
+        }
+
+        $msg->addEmbed($embed);
+
+        $interaction->respondWithMessage($msg, true);
+    }
+}