🚧 Initial Discord message components v2 implementation

src/Discord/Builders/Components/Component.php

@@ -31,6 +31,14 @@ abstract class Component implements JsonSerializable
     public const TYPE_ROLE_SELECT = 6;
     public const TYPE_MENTIONABLE_SELECT = 7;
     public const TYPE_CHANNEL_SELECT = 8;
+    public const TYPE_SECTION = 9;
+    public const TYPE_TEXT_DISPLAY = 10;
+    public const TYPE_THUMBNAIL = 11;
+    public const TYPE_MEDIA_GALLERY = 12;
+    public const TYPE_FILE = 13;
+    public const TYPE_SEPARATOR = 14;
+    public const TYPE_CONTENT_INVENTORY_ENTRY = 16;
+    public const TYPE_CONTAINER = 17;
 
     /** @deprecated 7.4.0 Use `Component::TYPE_STRING_SELECT` */
     public const TYPE_SELECT_MENU = 3;

src/Discord/Builders/Components/Container.php

@@ -0,0 +1,197 @@
+<?php
+
+/*
+ * This file is a part of the DiscordPHP project.
+ *
+ * Copyright (c) 2015-present David Cole <david.cole1340@gmail.com>
+ *
+ * This file is subject to the MIT license that is bundled
+ * with this source code in the LICENSE.md file.
+ */
+
+namespace Discord\Builders\Components;
+
+use Discord\Builders\Components\ActionRow;
+use Discord\Builders\Components\Section;
+use Discord\Builders\Components\TextDisplay;
+use Discord\Builders\Components\MediaGallery;
+use Discord\Builders\Components\File;
+use Discord\Builders\Components\Separator;
+
+/**
+ * Containers are a new way to group components together.
+ * You can also specify an accent color (similar to embeds) and spoiler it.
+ *
+ * @link https://discord.com/developers/docs/interactions/message-components#container
+ *
+ * @since 10.5.0
+ */
+class Container extends Component implements Contracts\ComponentV2
+{
+    /**
+     * Array of components.
+     *
+     * @var Component[]
+     */
+    private $components = [];
+
+    /**
+     * Accent color for the container.
+     *
+     * @var int|null
+     */
+    private $accent_color;
+
+    /**
+     * Whether the container is a spoiler.
+     *
+     * @var bool
+     */
+    private $spoiler = false;
+
+    /**
+     * Creates a new container.
+     *
+     * @return self
+     */
+    public static function new(): self
+    {
+        return new self();
+    }
+
+    /**
+     * Adds a component to the container.
+     *
+     * @param ActionRow|Section|TextDisplay|MediaGallery|File|Separator $component Component to add.
+     *
+     * @throws \InvalidArgumentException Component is not a valid type.
+     * @throws \OverflowException        Container exceeds 10 components.
+     *
+     * @return $this
+     */
+    public function addComponent(Component $component): self
+    {
+        if (count($this->components) >= 10) {
+            throw new \OverflowException('You can only have 10 components per container.');
+        }
+
+        if (! ( $component instanceof ActionRow || $component instanceof Section || $component instanceof TextDisplay || $component instanceof MediaGallery || $component instanceof File || $component instanceof Separator )) {
+            throw new \InvalidArgumentException('Invalid component type.');
+        }
+
+        $this->components[] = $component;
+
+        return $this;
+    }
+
+    /**
+     * Add a group of components to the container.
+     *
+     * @param Component[] $components Components to add.
+     *
+     * @throws \InvalidArgumentException Component is not a valid type.
+     *
+     * @return $this
+     */
+    public function addComponents(array $components): self
+    {
+        foreach ($components as $component) {
+            $this->addComponent($component);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Sets the components for the container.
+     *
+     * @param Component[] $components Components to set.
+     *
+     * @return $this
+     */
+    public function setComponents(array $components): self
+    {
+        $this->components = $components;
+
+        return $this;
+    }
+
+    /**
+     * Sets the accent color for the container.
+     *
+     * @param int|null $color Color code for the container.
+     *
+     * @return $this
+     */
+    public function setAccentColor(?int $color): self
+    {
+        $this->accent_color = $color;
+
+        return $this;
+    }
+
+    /**
+     * Sets whether the container is a spoiler.
+     *
+     * @param bool $spoiler Whether the container is a spoiler.
+     *
+     * @return $this
+     */
+    public function setSpoiler(bool $spoiler = true): self
+    {
+        $this->spoiler = $spoiler;
+
+        return $this;
+    }
+
+    /**
+     * Returns all the components in the container.
+     *
+     * @return Component[]
+     */
+    public function getComponents(): array
+    {
+        return $this->components;
+    }
+
+    /**
+     * Returns the accent color for the container.
+     *
+     * @return int|null
+     */
+    public function getAccentColor(): ?int
+    {
+        return $this->accent_color;
+    }
+
+    /**
+     * Returns whether the container is a spoiler.
+     *
+     * @return bool
+     */
+    public function isSpoiler(): bool
+    {
+        return $this->spoiler;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize(): array
+    {
+        $data = [
+            'type' => Component::TYPE_CONTAINER,
+            'components' => $this->components,
+        ];
+
+        if (isset($this->accent_color)) {
+            $data['accent_color'] = $this->accent_color;
+        }
+
+        if ($this->spoiler) {
+            $data['spoiler'] = true;
+        }
+
+        return $data;
+    }
+}

src/Discord/Builders/Components/Contracts/ComponentV2.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is a part of the DiscordPHP project.
+ *
+ * Copyright (c) 2015-present David Cole <david.cole1340@gmail.com>
+ *
+ * This file is subject to the MIT license that is bundled
+ * with this source code in the LICENSE.md file.
+ */
+
+namespace Discord\Builders\Components\Contracts;
+
+/**
+ * This interface is a contract for V2 components.
+ *
+ * @since 10.5.0
+ */
+interface ComponentV2
+{
+    //
+}

src/Discord/Builders/Components/File.php

@@ -0,0 +1,125 @@
+<?php
+
+/*
+ * This file is a part of the DiscordPHP project.
+ *
+ * Copyright (c) 2015-present David Cole <david.cole1340@gmail.com>
+ *
+ * This file is subject to the MIT license that is bundled
+ * with this source code in the LICENSE.md file.
+ */
+
+namespace Discord\Builders\Components;
+
+use Discord\Parts\Channel\Attachment;
+
+/**
+ * File components allow you to send a file. You can also spoiler it.
+ *
+ * @link https://discord.com/developers/docs/interactions/message-components#file
+ *
+ * @since 10.5.0
+ */
+class File extends Component implements Contracts\ComponentV2
+{
+    /**
+     * The file to be displayed.
+     *
+     * @var array
+     */
+    private $file;
+
+    /**
+     * Whether the file is a spoiler.
+     *
+     * @var bool
+     */
+    private $spoiler = false;
+
+    /**
+     * Creates a new file component.
+     *
+     * @param string|Attachment|null $filename The filename or attachment to reference.
+     *
+     * @return self
+     */
+    public static function new(string|Attachment|null $filename = null): self
+    {
+        $component = new self();
+
+        if ($filename !== null) {
+            $component->setFile($filename);
+        }
+
+        return $component;
+    }
+
+    /**
+     * Sets the file to be displayed.
+     *
+     * @param string|Attachment $filename The filename or attachment to reference.
+     *
+     * @return $this
+     */
+    public function setFile(string|Attachment $filename): self
+    {
+        if ($filename instanceof Attachment) {
+            $filename = $filename->filename;
+        }
+
+        $this->file = ['url' => "attachment://{$filename}"];
+
+        return $this;
+    }
+
+    /**
+     * Sets whether the file is a spoiler.
+     *
+     * @param bool $spoiler Whether the file is a spoiler.
+     *
+     * @return $this
+     */
+    public function setSpoiler(bool $spoiler = true): self
+    {
+        $this->spoiler = $spoiler;
+
+        return $this;
+    }
+
+    /**
+     * Returns the file reference.
+     *
+     * @return array
+     */
+    public function getFile(): array
+    {
+        return $this->file;
+    }
+
+    /**
+     * Returns whether the file is a spoiler.
+     *
+     * @return bool
+     */
+    public function isSpoiler(): bool
+    {
+        return $this->spoiler;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize(): array
+    {
+        $data = [
+            'type' => Component::TYPE_FILE,
+            'file' => $this->file,
+        ];
+
+        if ($this->spoiler) {
+            $data['spoiler'] = true;
+        }
+
+        return $data;
+    }
+}