compatibility badges

NamelessMC · Mar 24, 2023 · 21289a2 · 21289a2
1 parent 7147e07
commit 21289a2
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 28 deletions.
diff --git a/core/classes/Events/EventHandler.php b/core/classes/Events/EventHandler.php
@@ -203,19 +203,28 @@ public static function executeEvent($event, array $params = []): ?array {
     /**
      * Get a list of events to display on the StaffCP webhooks page.
      *
-     * @param bool $internal Whether to include internal events or not
      * @return array List of all currently registered events
      */
-    public static function getEvents(bool $internal = false): array {
+    public static function getEvents(): array {
         $return = [];
 
         foreach (self::$_events as $name => $meta) {
-            if (!$meta['internal'] || $internal) {
-                if (is_callable($meta['description'])) {
-                    $meta['description'] = $meta['description']();
-                }
-                $return[$name] = $meta['description'];
+            if ($meta['internal']) {
+                continue;
+            }
+
+            if (is_callable($meta['description'])) {
+                $description = $meta['description']();
+            } else {
+                $description = $meta['description'];
             }
+
+            $class = $meta['class_name'];
+            $return[$name] = [
+                'description' => $description,
+                'supports_discord' => $class !== null && is_subclass_of($class, DiscordDispatchable::class),
+                'supports_normal' => $class !== null && is_subclass_of($class, HasWebhookParams::class),
+            ];
         }
 
         return $return;

diff --git a/custom/languages/en_UK.json b/custom/languages/en_UK.json
@@ -146,6 +146,7 @@
     "admin/details": "Details",
     "admin/disable": "Disable",
     "admin/disabled": "Disabled",
+    "admin/discord_hook": "Discord",
     "admin/display_field_on_forum": "Display field on forum?",
     "admin/download": "Download",
     "admin/download_sitemap": "Download Sitemap",

diff --git a/custom/panel_templates/Default/core/hooks_edit.tpl b/custom/panel_templates/Default/core/hooks_edit.tpl
@@ -64,18 +64,27 @@
                                 <div class="form-group">
                                     <label for="link_location">{$HOOK_TYPE}</label>
                                     <select class="form-control" id="hook_type" name="hook_type">
-                                        <option value="2" {if $HOOK_TYPE_VALUE eq 2} selected{/if}>Discord</option>
-                                        <option value="1" {if $HOOK_TYPE_VALUE eq 1} selected{/if}>{$NORMAL}</option>
+                                        <option value="2" {if $HOOK_TYPE_VALUE eq 2} selected{/if}>
+                                            {$DISCORD}
+                                        </option>
+                                        <option value="1" {if $HOOK_TYPE_VALUE eq 1} selected{/if}>
+                                            {$NORMAL}
+                                        </option>
                                     </select>
                                 </div>
                                 <label for="InputName">{$HOOK_EVENTS}</label>
-                                {foreach from=$ALL_EVENTS key=key item=item}
+                                {foreach from=$ALL_EVENTS key=key item=meta}
                                 <div class="form-group custom-control custom-switch">
-                                    <input type="checkbox" id="inputevents[{$key|escape}]" name="events[{$key|escape}]"
-                                        class="custom-control-input" value="1" {if in_array($key|escape,
-                                        $ENABLED_HOOKS)} checked{/if}>
+                                    <input type="checkbox" id="inputevents[{$key|escape}]" name="events[{$key|escape}]" class="custom-control-input" value="1" {if in_array($key|escape, $ENABLED_HOOKS)} checked{/if}>
                                     <label class="custom-control-label" for="inputevents[{$key|escape}]">
-                                        {$item|escape}
+                                        {$meta.description|escape}
+                                        {if $meta.supports_discord}
+                                            <span class="badge badge-info">Supports Discord</span>
+                                        {/if}
+                                        {if $meta.supports_normal}
+                                            <span class="badge badge-info">Supports Normal</span>
+                                        {/if}
+
                                     </label>
                                 </div>
                                 {/foreach}
@@ -109,4 +118,4 @@
 
 </body>
 
-</html>
+</html>
diff --git a/custom/panel_templates/Default/core/hooks_new.tpl b/custom/panel_templates/Default/core/hooks_new.tpl
@@ -64,19 +64,24 @@
                                 <div class="form-group">
                                     <label for="link_location">{$HOOK_TYPE}</label>
                                     <select class="form-control" id="hook_type" name="hook_type">
-                                        <option value="2">Discord</option>
+                                        <option value="2">{$DISCORD}</option>
                                         <option value="1">{$NORMAL}</option>
                                     </select>
                                 </div>
                                 <label for="InputName">{$HOOK_EVENTS}</label>
-                                {foreach from=$ALL_EVENTS key=key item=item}
-                                <div class="form-group custom-control custom-switch">
-                                    <input type="checkbox" id="inputevents[{$key|escape}]" name="events[{$key|escape}]"
-                                        class="custom-control-input">
-                                    <label class="custom-control-label" for="inputevents[{$key|escape}]">
-                                        {$item|escape}
-                                    </label>
-                                </div>
+                                {foreach from=$ALL_EVENTS key=key item=meta}
+                                    <div class="form-group custom-control custom-switch">
+                                        <input type="checkbox" id="inputevents[{$key|escape}]" name="events[{$key|escape}]" class="custom-control-input">
+                                        <label class="custom-control-label" for="inputevents[{$key|escape}]">
+                                            {$meta.description|escape}
+                                            {if $meta.supports_discord}
+                                                <span class="badge badge-info">Supports Discord</span>
+                                            {/if}
+                                            {if $meta.supports_normal}
+                                                <span class="badge badge-info">Supports Normal</span>
+                                            {/if}
+                                        </label>
+                                    </div>
                                 {/foreach}
                                 <div class="form-group">
                                     <input type="hidden" name="token" value="{$TOKEN}">
@@ -108,4 +113,4 @@
 
 </body>
 
-</html>
+</html>
diff --git a/modules/Core/classes/Events/AnnouncementCreatedEvent.php b/modules/Core/classes/Events/AnnouncementCreatedEvent.php
@@ -17,7 +17,7 @@ public static function name(): string {
     }
 
     public static function description(): string {
-        return (new Language(ROOT_PATH . '/modules/Forum/language'))->get('forum', 'new_topic_hook_info');
+        return (new Language())->get('admin', 'announcement_hook_info');
     }
 
     public function toDiscordWebhook(): DiscordWebhookBuilder {

diff --git a/modules/Core/pages/panel/hooks.php b/modules/Core/pages/panel/hooks.php
@@ -114,6 +114,7 @@
                 'HOOK_EVENTS' => $language->get('admin', 'hook_events'),
                 'BACK' => $language->get('general', 'back'),
                 'BACK_LINK' => URL::build('/panel/core/hooks'),
+                'DISCORD' => $language->get('admin', 'discord_hook'),
                 'NORMAL' => $language->get('general', 'normal'),
                 'ALL_EVENTS' => EventHandler::getEvents(),
             ]);
@@ -200,6 +201,7 @@
                 'HOOK_EVENTS' => $language->get('admin', 'hook_events'),
                 'BACK' => $language->get('general', 'back'),
                 'BACK_LINK' => URL::build('/panel/core/hooks'),
+                'DISCORD' => $language->get('admin', 'discord_hook'),
                 'NORMAL' => $language->get('general', 'normal'),
                 'ALL_EVENTS' => EventHandler::getEvents(),
                 'ENABLED_HOOKS' => json_decode($hook->events, true)

diff --git a/modules/Forum/classes/Events/TopicCreatedEvent.php b/modules/Forum/classes/Events/TopicCreatedEvent.php
@@ -1,6 +1,6 @@
 <?php
 
-class TopicCreatedEvent extends AbstractEvent implements DiscordDispatchable {
+class TopicCreatedEvent extends AbstractEvent implements DiscordDispatchable, HasWebhookParams {
 
     public User $creator;
     public string $forum_title;
@@ -30,7 +30,7 @@ public static function name(): string {
     }
 
     public static function description(): string {
-        return (new Language())->get('admin', 'announcement_hook_info');
+        return (new Language(ROOT_PATH . '/modules/Forum/language'))->get('forum', 'new_topic');
     }
 
     public function toDiscordWebhook(): DiscordWebhookBuilder {
@@ -51,4 +51,8 @@ public function toDiscordWebhook(): DiscordWebhookBuilder {
                     ->setUrl(URL::getSelfURL() . ltrim(URL::build('/forum/topic/' . urlencode($this->topic_id) . '-' . $forum->titleToURL($this->topic_title)), '/'));
             });
     }
+
+    public function webhookParams(): array {
+        return [];
+    }
 }