feat: add rich text block, elements and parts

Author: maartenpaauw

src/Blocks/RichText.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Blocks;
+
+use SlackPhp\BlockKit\Collections\RichTextSubCollection;
+use SlackPhp\BlockKit\Elements\RichTexts\RichTextSubElement;
+use SlackPhp\BlockKit\Property;
+use SlackPhp\BlockKit\Validation\RequiresAllOf;
+use SlackPhp\BlockKit\Validation\ValidCollection;
+
+#[RequiresAllOf('elements')]
+class RichText extends Block
+{
+    #[Property, ValidCollection]
+    public RichTextSubCollection $elements;
+
+    /**
+     * @param RichTextSubCollection|array<RichTextSubCollection|RichTextSubElement|null> $elements
+     */
+    public function __construct(RichTextSubCollection|array $elements = [], ?string $blockId = null)
+    {
+        parent::__construct($blockId);
+        $this->elements = new RichTextSubCollection();
+        $this->elements(...$elements);
+    }
+
+    public function elements(RichTextSubCollection|RichTextSubElement|null ...$elements): self
+    {
+        $this->elements->append(...$elements);
+
+        return $this;
+    }
+}

src/Collections/RichTextCollection.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Collections;
+
+use SlackPhp\BlockKit\Component;
+use SlackPhp\BlockKit\Elements\RichTexts\RichTextElement;
+use SlackPhp\BlockKit\Elements\RichTexts\Text;
+
+/**
+ * @extends ComponentCollection<RichTextElement>
+ */
+class RichTextCollection extends ComponentCollection
+{
+    protected static function createComponent(array $data): Component
+    {
+        return RichTextElement::fromArray($data);
+    }
+
+    /**
+     * @param array<RichTextElement|self|string|null> $elements
+     */
+    public function __construct(array $elements = [])
+    {
+        $this->append(...$elements);
+    }
+
+    public function append(RichTextElement|self|string|null ...$elements): void
+    {
+        $this->add($elements);
+    }
+
+    public function prepend(RichTextElement|self|string|null ...$elements): void
+    {
+        $this->add($elements, true);
+    }
+
+    protected function prepareItems(array $items): iterable
+    {
+        foreach ($items as $element) {
+            if ($element instanceof RichTextElement) {
+                yield $element;
+            } elseif ($element instanceof self) {
+                yield from $element;
+            } elseif (is_string($element)) {
+                yield Text::wrap($element);
+            }
+        }
+    }
+}

src/Collections/RichTextSectionCollection.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Collections;
+
+use SlackPhp\BlockKit\Component;
+use SlackPhp\BlockKit\Elements\RichTexts\RichTextSection;
+
+/**
+ * @extends ComponentCollection<RichTextSection>
+ */
+class RichTextSectionCollection extends ComponentCollection
+{
+    protected static function createComponent(array $data): Component
+    {
+        return RichTextSection::fromArray($data);
+    }
+
+    /**
+     * @param array<RichTextSection|self|string|null> $sections
+     */
+    public function __construct(array $sections = [])
+    {
+        $this->append(...$sections);
+    }
+
+    public function append(RichTextSection|self|string|null ...$elements): void
+    {
+        $this->add($elements);
+    }
+
+    public function prepend(RichTextSection|self|string|null ...$elements): void
+    {
+        $this->add($elements, true);
+    }
+
+
+    protected function prepareItems(array $items): iterable
+    {
+        foreach ($items as $section) {
+            if ($section instanceof RichTextSection) {
+                yield $section;
+            } elseif ($section instanceof self) {
+                yield from $section;
+            } elseif (is_string($section)) {
+                yield RichTextSection::wrap($section);
+            }
+        }
+    }
+}

src/Collections/RichTextSubCollection.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Collections;
+
+use SlackPhp\BlockKit\Component;
+use SlackPhp\BlockKit\Elements\RichTexts\RichTextSubElement;
+
+/**
+ * @extends ComponentCollection<RichTextSubElement>
+ */
+class RichTextSubCollection extends ComponentCollection
+{
+    protected static function createComponent(array $data): Component
+    {
+        return RichTextSubElement::fromArray($data);
+    }
+
+    /**
+     * @param array<RichTextSubElement|self|null> $elements
+     */
+    public function __construct(array $elements = [])
+    {
+        $this->append(...$elements);
+    }
+
+    public function append(RichTextSubElement|self|null ...$elements): void
+    {
+        $this->add($elements);
+    }
+
+    public function prepend(RichTextSubElement|self|null ...$elements): void
+    {
+        $this->add($elements, true);
+    }
+
+    protected function prepareItems(array $items): iterable
+    {
+        foreach ($items as $element) {
+            if ($element instanceof RichTextSubElement) {
+                yield $element;
+            } elseif ($element instanceof self) {
+                yield from $element;
+            }
+        }
+    }
+}

src/Collections/TextCollection.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Collections;
+
+use SlackPhp\BlockKit\Component;
+use SlackPhp\BlockKit\Elements\RichTexts\Text;
+
+/**
+ * @extends ComponentCollection<Text>
+ */
+class TextCollection extends ComponentCollection
+{
+    protected static function createComponent(array $data): Component
+    {
+        return Text::fromArray($data);
+    }
+
+    /**
+     * @param array<Text|self|string|null> $elements
+     */
+    public function __construct(array $elements = [])
+    {
+        $this->append(...$elements);
+    }
+
+    public function append(Text|self|string|null ...$elements): void
+    {
+        $this->add($elements);
+    }
+
+    public function prepend(Text|self|string|null ...$elements): void
+    {
+        $this->add($elements, true);
+    }
+
+    protected function prepareItems(array $items): iterable
+    {
+        foreach ($items as $text) {
+            if ($text instanceof Text) {
+                yield $text;
+            } elseif ($text instanceof self) {
+                yield from $text;
+            } elseif (is_string($text)) {
+                yield Text::wrap($text);
+            }
+        }
+    }
+}

src/Elements/RichTexts/Broadcast.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Elements\RichTexts;
+
+use SlackPhp\BlockKit\Parts\Range;
+use SlackPhp\BlockKit\Property;
+use SlackPhp\BlockKit\Validation\RequiresAllOf;
+
+#[RequiresAllOf('range')]
+class Broadcast extends RichTextElement
+{
+    #[Property]
+    public ?Range $range;
+
+    public function __construct(Range|string|null $range = null)
+    {
+        parent::__construct();
+        $this->range($range);
+    }
+
+    public function range(Range|string|null $range): self
+    {
+        $this->range = Range::fromValue($range);
+
+        return $this;
+    }
+}

src/Elements/RichTexts/Channel.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Elements\RichTexts;
+
+use SlackPhp\BlockKit\Elements\RichTexts\Traits\HasMentionStyle;
+use SlackPhp\BlockKit\Parts\MentionStyle;
+use SlackPhp\BlockKit\Property;
+use SlackPhp\BlockKit\Validation\RequiresAllOf;
+use SlackPhp\BlockKit\Validation\ValidString;
+
+#[RequiresAllOf('channel_id')]
+class Channel extends RichTextElement
+{
+    use HasMentionStyle;
+
+    #[Property('channel_id'), ValidString]
+    public ?string $channelId;
+
+    public function __construct(?string $channelId = null, ?MentionStyle $style = null)
+    {
+        parent::__construct();
+
+        $this->channelId($channelId);
+        $this->style($style);
+    }
+
+    public function channelId(?string $channelId): self
+    {
+        $this->channelId = $channelId;
+
+        return $this;
+    }
+}

src/Elements/RichTexts/Color.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlackPhp\BlockKit\Elements\RichTexts;
+
+use SlackPhp\BlockKit\Property;
+use SlackPhp\BlockKit\Validation\RequiresAllOf;
+use SlackPhp\BlockKit\Validation\ValidString;
+
+#[RequiresAllOf('value')]
+class Color extends RichTextElement
+{
+    #[Property, ValidString]
+    public ?string $value;
+
+    public function __construct(?string $value = null)
+    {
+        parent::__construct();
+        $this->value($value);
+    }
+
+    public function value(?string $value): self
+    {
+        $this->value = $value;
+
+        return $this;
+    }
+}