Second pass

Author: valzargaming

README.md

@@ -0,0 +1,83 @@
+# DiscordPHP EventLogger
+
+DiscordPHP EventLogger is a tool designed to generate user logs for the DiscordPHP API Library. It logs various events such as member joins/leaves, message deletions, role updates, and more.
+
+## Features
+
+- Logs member joins and leaves
+- Logs message deletions and updates
+- Logs role creations, deletions, and updates
+- Logs channel creations, deletions, and updates
+- Logs bans and unbans
+
+## Installation
+
+To install the DiscordPHP EventLogger, you need to have Composer installed. Run the following command:
+
+```bash
+composer require valgorithms/discord-php-eventlogger
+```
+
+## Usage
+
+### Configuration
+
+Set the `DISCORDPHP_EVENTLOGGER_GUILD_CHANNELS` environment variable to specify the guilds and their respective log channels. The value should be a comma-separated string where each entry is a guild-channel pair separated by a hyphen.
+
+Example:
+```
+DISCORDPHP_EVENTLOGGER_GUILD_CHANNELS=1077144430588469349-1077144432463314998,1253459964849164328-1253480680583860367
+```
+
+### Example
+
+Here is an example of how to use the EventLogger in your project:
+
+```php
+require 'vendor/autoload.php';
+
+use Discord\Discord;
+use EventLogger\EventLogger;
+
+$discord = new Discord([
+    'token' => 'YOUR_DISCORD_BOT_TOKEN',
+]);
+
+$events = [
+    'CHANNEL_CREATE',
+    'CHANNEL_DELETE',
+    'CHANNEL_UPDATE',
+    'GUILD_BAN_ADD',
+    'GUILD_BAN_REMOVE',
+    'GUILD_MEMBER_ADD',
+    'GUILD_MEMBER_REMOVE',
+    'GUILD_MEMBER_UPDATE',
+    'MESSAGE_DELETE',
+    'GUILD_ROLE_CREATE',
+    'GUILD_ROLE_DELETE',
+    'GUILD_ROLE_UPDATE',
+];
+
+$eventLogger = new EventLogger($discord, $events);
+
+$discord->run();
+```
+
+### Custom Events
+
+You can add custom events by modifying the `createDefaultEventListeners` method in the `EventLoggerTrait` trait.
+
+```php
+private function createDefaultEventListeners(array $events = []): void
+{
+    // Add your custom event listeners here
+}
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
+
+## Credits
+
+DiscordPHP EventLogger by Valithor Obsidion

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "valgorithms/discord-php-eventlogger",
-    "description": "DiscordPHP EventLogger is a tool designed to generate user logs for the DiscordPHP API Library.",
+    "description": "DiscordPHP EventLogger is a tool designed to generate guild specific logs for the DiscordPHP API Library.",
     "keywords": ["discordphp", "discord", "php", "event logger", "logging"],
     "license": "MIT",
     "authors": [
@@ -11,13 +11,15 @@
     ],
     "require": {
         "php": ">=8.0",
-        "team-reflex/discord-php": "^10.0.0"
+        "team-reflex/discord-php": "^10.0.0 || dev-master"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "autoload": {
         "psr-4": {
-            "EventLogger\\": "src/EventLogger/"
+            "EventLogger\\": "src/EventLogger/",
+            "EmbedBuilder\\": "src/EmbedBuilder/",
+            "MessageBuilderHelper\\": "src/MessageBuilderHelper/"
         }
     }
 }

src/EmbedBuilder/EmbedBuilder.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is a part of the DiscordPHP EventLogger project.
+ *
+ * Copyright (c) 2024-present Valithor Obsidion <valithor@valzargaming.com>
+ */
+
+namespace EmbedBuilder;
+
+class EmbedBuilder implements EmbedBuilderInterface
+{
+    use EmbedBuilderTrait;
+}

src/EmbedBuilder/EmbedBuilderInterface.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is a part of the DiscordPHP EventLogger project.
+ *
+ * Copyright (c) 2024-present Valithor Obsidion <valithor@valzargaming.com>
+ */
+
+namespace EmbedBuilder;
+
+use Discord\Discord;
+use Discord\Parts\Embed\Embed;
+
+interface EmbedBuilderInterface
+{
+    public static function new(
+        Embed|null $embed = null,
+        string|null $title = null, // Event
+        string|null $description = null,
+        array $fields = [],
+        Discord|null $discord = null,
+        string|int|null $color = null,
+        string|null $footer = null
+    ): Embed;
+}

src/EmbedBuilder/EmbedBuilderTrait.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is a part of the DiscordPHP EventLogger project.
+ *
+ * Copyright (c) 2024-present Valithor Obsidion <valithor@valzargaming.com>
+ */
+
+namespace EmbedBuilder;
+
+use Discord\Discord;
+use Discord\Parts\Embed\Embed;
+
+trait EmbedBuilderTrait
+{
+    /**
+     * Creates an Embed object with the specified footer and color.
+     *
+     * @param bool|null $footer Whether to include the footer in the embed. Defaults to true.
+     * @param int|null $color The color of the embed. Defaults to null.
+     * 
+     * @return Embed The created Embed object.
+     */
+    private static function createEmbed(
+        Discord $discord,
+        string|int|null $color = null,
+        string|null $footer = null
+    ): Embed
+    {
+        return (new Embed($discord))
+            ->setFooter($footer ?: '')
+            ->setColor($color ?: null)
+            ->setTimestamp()
+            ->setURL('');
+    }
+
+    /**
+     * Fills an Embed object with the provided fields.
+     *
+     * @param string|null $title The title of the embed (Event).
+     * @param string|null $description The description of the embed.
+     * @param Embed|null $embed The Embed object to fill. If null, a new Embed object will be created.
+     * @param Discord|null $discord The Discord instance. If null, an Embed instance must be provided.
+     * @param string|int|null $color The color of the embed. Can be a hex string or an integer. If null, a default color will be used.
+     * @param string|null $embed_footer The footer text of the embed. If null, no footer will be added.
+     * @param array $fields Array containing associative arrays of fields to add to the Embed. Each field should have 'name', 'value', and optionally 'inline' keys.
+     * @return Embed The filled Embed object.
+     * @throws \Exception If both Discord and Embed instances are null.
+     */
+    public static function new(
+        Embed|null $embed = null,
+        string|null $title = null, // Event
+        string|null $description = null,
+        array $fields = [],
+        Discord|null $discord = null,
+        string|int|null $color = null,
+        string|null $footer = null
+    ): Embed
+    {
+        if ($discord === null && $embed === null) throw new \Exception('Either Discord or Embed instance must be provided');
+        
+        $embed = $embed ?? self::createEmbed($discord, $color, $footer);
+
+        if ($title) $embed->setTitle($title);
+        if ($description) $embed->setDescription($description);
+
+        array_walk($fields, fn($field) => isset($field['name'], $field['value']) ? $embed->addFieldValues($field['name'], $field['value'], $field['inline'] ?? false) : null);
+
+        return $embed;
+    }
+}

src/EventLogger/EventLogger.php

@@ -6,7 +6,12 @@
  * Copyright (c) 2024-present Valithor Obsidion <valithor@valzargaming.com>
  */
 
-class EventLogger
+namespace EventLogger;
+
+use EmbedBuilder\EmbedBuilderTrait;
+
+class EventLogger implements EventLoggerInterface
 {
     use EventLoggerTrait;
+    use EmbedBuilderTrait;
 }

src/EventLogger/EventLoggerInterface.php

@@ -4,4 +4,10 @@
  * This file is a part of the DiscordPHP EventLogger project.
  *
  * Copyright (c) 2024-present Valithor Obsidion <valithor@valzargaming.com>
- */
+ */
+
+namespace EventLogger;
+
+interface EventLoggerInterface
+{
+}