[TASK] Rename ExtensionElementInterface to ExtensionContentsInterface

This avoids confusion with DOM elements as they do not return any DOM elements.
brotkrueml · Nov 25, 2022 · 4f03dba · 4f03dba
1 parent 1ffb7bb
commit 4f03dba
Show file tree

Hide file tree

Showing 28 changed files with 75 additions and 75 deletions.
diff --git a/Classes/Configuration/ExtensionRegistry.php b/Classes/Configuration/ExtensionRegistry.php
@@ -11,7 +11,7 @@
 
 namespace Brotkrueml\FeedGenerator\Configuration;
 
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 use Brotkrueml\FeedGenerator\Contract\JsonExtensionInterface;
 use Brotkrueml\FeedGenerator\Contract\XmlExtensionInterface;
 use Brotkrueml\FeedGenerator\Format\FeedFormat;
@@ -32,11 +32,11 @@ public function __construct(
     /**
      * @return ($format is FeedFormat::JSON ? JsonExtensionInterface : XmlExtensionInterface)|null
      */
-    public function getExtensionForElement(FeedFormat $format, ExtensionElementInterface $element): JsonExtensionInterface|XmlExtensionInterface|null
+    public function getExtensionForContent(FeedFormat $format, ExtensionContentInterface $content): JsonExtensionInterface|XmlExtensionInterface|null
     {
         $extensions = $format === FeedFormat::JSON ? $this->getExtensionsForJsonFormat() : $this->getExtensionsForXmlFormat();
         foreach ($extensions as $extension) {
-            if ($extension->canHandle($element)) {
+            if ($extension->canHandle($content)) {
                 return $extension;
             }
         }

diff --git a/Classes/Configuration/ExtensionRegistryInterface.php b/Classes/Configuration/ExtensionRegistryInterface.php
@@ -11,7 +11,7 @@
 
 namespace Brotkrueml\FeedGenerator\Configuration;
 
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 use Brotkrueml\FeedGenerator\Contract\JsonExtensionInterface;
 use Brotkrueml\FeedGenerator\Contract\XmlExtensionInterface;
 use Brotkrueml\FeedGenerator\Format\FeedFormat;
@@ -24,7 +24,7 @@ interface ExtensionRegistryInterface
     /**
      * @return ($format is FeedFormat::JSON ? JsonExtensionInterface : XmlExtensionInterface)|null
      */
-    public function getExtensionForElement(FeedFormat $format, ExtensionElementInterface $element): JsonExtensionInterface|XmlExtensionInterface|null;
+    public function getExtensionForContent(FeedFormat $format, ExtensionContentInterface $content): JsonExtensionInterface|XmlExtensionInterface|null;
 
     /**
      * @return iterable<JsonExtensionInterface|XmlExtensionInterface>

diff --git a/Classes/Contract/CollectableInterface.php b/Classes/Contract/CollectableInterface.php
@@ -20,7 +20,7 @@
 #[Sealed(permits: [
     AttachmentInterface::class,
     AuthorInterface::class,
-    ExtensionElementInterface::class,
+    ExtensionContentInterface::class,
     CategoryInterface::class,
     ItemInterface::class,
 ])]

diff --git a/...es/Contract/ExtensionElementInterface.php → ...es/Contract/ExtensionContentInterface.php b/...es/Contract/ExtensionElementInterface.php → ...es/Contract/ExtensionContentInterface.php
@@ -12,9 +12,9 @@
 namespace Brotkrueml\FeedGenerator\Contract;
 
 /**
- * A marker interface for extension elements
+ * A marker interface for extension content
  * @api
  */
-interface ExtensionElementInterface extends CollectableInterface
+interface ExtensionContentInterface extends CollectableInterface
 {
 }
diff --git a/Classes/Contract/ExtensionInterface.php b/Classes/Contract/ExtensionInterface.php
@@ -24,7 +24,7 @@
 ])]
 interface ExtensionInterface
 {
-    public function canHandle(ExtensionElementInterface $element): bool;
+    public function canHandle(ExtensionContentInterface $content): bool;
 
     public function getQualifiedName(): string;
 }
diff --git a/Classes/Contract/FeedInterface.php b/Classes/Contract/FeedInterface.php
@@ -94,8 +94,8 @@ public function getItems(): Collection;
     public function getStyleSheet(): string;
 
     /**
-     * Get extension elements
-     * @return Collection<ExtensionElementInterface>
+     * Get extension contents for the feed
+     * @return Collection<ExtensionContentInterface>
      */
-    public function getExtensionElements(): Collection;
+    public function getExtensionContents(): Collection;
 }
diff --git a/Classes/Contract/ItemInterface.php b/Classes/Contract/ItemInterface.php
@@ -72,8 +72,8 @@ public function getDateModified(): ?\DateTimeInterface;
     public function getAttachments(): Collection;
 
     /**
-     * Get extension elements
-     * @return Collection<ExtensionElementInterface>
+     * Get extension contents for the item
+     * @return Collection<ExtensionContentInterface>
      */
-    public function getExtensionElements(): Collection;
+    public function getExtensionContents(): Collection;
 }
diff --git a/Classes/Contract/JsonExtensionRendererInterface.php b/Classes/Contract/JsonExtensionRendererInterface.php
@@ -21,5 +21,5 @@ interface JsonExtensionRendererInterface extends ExtensionRendererInterface
     /**
      * @return array<string, mixed>
      */
-    public function render(ExtensionElementInterface $element): array;
+    public function render(ExtensionContentInterface $content): array;
 }
diff --git a/Classes/Contract/XmlExtensionRendererInterface.php b/Classes/Contract/XmlExtensionRendererInterface.php
@@ -18,5 +18,5 @@
  */
 interface XmlExtensionRendererInterface extends ExtensionRendererInterface
 {
-    public function render(ExtensionElementInterface $element, \DOMNode $parent, \DOMDocument $document): void;
+    public function render(ExtensionContentInterface $content, \DOMNode $parent, \DOMDocument $document): void;
 }
diff --git a/Classes/Entity/AbstractFeed.php b/Classes/Entity/AbstractFeed.php
@@ -14,7 +14,7 @@
 use Brotkrueml\FeedGenerator\Collection\Collection;
 use Brotkrueml\FeedGenerator\Contract\AuthorInterface;
 use Brotkrueml\FeedGenerator\Contract\CategoryInterface;
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 use Brotkrueml\FeedGenerator\Contract\FeedInterface;
 use Brotkrueml\FeedGenerator\Contract\ImageInterface;
 use Brotkrueml\FeedGenerator\Contract\ItemInterface;
@@ -106,9 +106,9 @@ public function getStyleSheet(): string
     }
 
     /**
-     * @return Collection<ExtensionElementInterface>
+     * @return Collection<ExtensionContentInterface>
      */
-    public function getExtensionElements(): Collection
+    public function getExtensionContents(): Collection
     {
         return new Collection();
     }

diff --git a/Classes/Entity/Item.php b/Classes/Entity/Item.php
@@ -14,7 +14,7 @@
 use Brotkrueml\FeedGenerator\Collection\Collection;
 use Brotkrueml\FeedGenerator\Contract\AttachmentInterface;
 use Brotkrueml\FeedGenerator\Contract\AuthorInterface;
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 use Brotkrueml\FeedGenerator\Contract\ItemInterface;
 use Brotkrueml\FeedGenerator\Contract\TextInterface;
 
@@ -39,15 +39,15 @@ final class Item implements ItemInterface
      */
     private readonly Collection $attachments;
     /**
-     * @var Collection<ExtensionElementInterface>
+     * @var Collection<ExtensionContentInterface>
      */
-    private readonly Collection $extensionElements;
+    private readonly Collection $extensionContents;
 
     public function __construct()
     {
         $this->attachments = new Collection();
         $this->authors = new Collection();
-        $this->extensionElements = new Collection();
+        $this->extensionContents = new Collection();
     }
 
     public function getId(): string
@@ -164,18 +164,18 @@ public function addAttachments(AttachmentInterface ...$attachments): self
         return $this;
     }
 
-    public function addExtensionElements(ExtensionElementInterface ...$elements): self
+    public function addExtensionContents(ExtensionContentInterface ...$contents): self
     {
-        $this->extensionElements->add(...$elements);
+        $this->extensionContents->add(...$contents);
 
         return $this;
     }
 
     /**
-     * @return Collection<ExtensionElementInterface>
+     * @return Collection<ExtensionContentInterface>
      */
-    public function getExtensionElements(): Collection
+    public function getExtensionContents(): Collection
     {
-        return $this->extensionElements;
+        return $this->extensionContents;
     }
 }
diff --git a/Classes/Renderer/AtomRenderer.php b/Classes/Renderer/AtomRenderer.php
@@ -91,12 +91,12 @@ public function render(FeedInterface $feed, string $feedLink): string
             $categoryNode->add($category);
         }
 
-        foreach ($feed->getExtensionElements() as $element) {
-            $extension = $this->extensionRegistry->getExtensionForElement(FeedFormat::ATOM, $element);
+        foreach ($feed->getExtensionContents() as $content) {
+            $extension = $this->extensionRegistry->getExtensionForContent(FeedFormat::ATOM, $content);
             if (! $extension instanceof XmlExtensionInterface) {
                 continue;
             }
-            $extension->getXmlRenderer()->render($element, $rootElement, $this->document);
+            $extension->getXmlRenderer()->render($content, $rootElement, $this->document);
             $this->usedExtensions[$extension->getQualifiedName()] = $extension->getNamespace();
         }
 

diff --git a/Classes/Renderer/JsonRenderer.php b/Classes/Renderer/JsonRenderer.php
@@ -15,7 +15,7 @@
 use Brotkrueml\FeedGenerator\Configuration\ExtensionRegistryInterface;
 use Brotkrueml\FeedGenerator\Contract\AttachmentInterface;
 use Brotkrueml\FeedGenerator\Contract\AuthorInterface;
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 use Brotkrueml\FeedGenerator\Contract\FeedInterface;
 use Brotkrueml\FeedGenerator\Contract\ImageInterface;
 use Brotkrueml\FeedGenerator\Contract\JsonExtensionInterface;
@@ -63,8 +63,8 @@ public function render(FeedInterface $feed, string $feedLink): string
         if ($feed->getLanguage() !== '') {
             $resultArray['language'] = $feed->getLanguage();
         }
-        foreach ($feed->getExtensionElements() as $element) {
-            $resultArray = [...$resultArray, ...$this->renderExtensionContent($element)];
+        foreach ($feed->getExtensionContents() as $content) {
+            $resultArray = [...$resultArray, ...$this->renderExtensionContent($content)];
         }
 
         $resultArray['items'] = [];
@@ -99,7 +99,7 @@ public function render(FeedInterface $feed, string $feedLink): string
             if (! $item->getAttachments()->isEmpty()) {
                 $itemArray['attachments'] = $this->buildAttachmentsArray($item->getAttachments());
             }
-            foreach ($item->getExtensionElements() as $element) {
+            foreach ($item->getExtensionContents() as $element) {
                 $itemArray = [...$itemArray, ...$this->renderExtensionContent($element)];
             }
             $resultArray['items'][] = $itemArray;
@@ -164,9 +164,9 @@ private function buildAttachmentsArray(Collection $attachments): array
     /**
      * @return array<string, array<string, mixed>>
      */
-    private function renderExtensionContent(ExtensionElementInterface $element): array
+    private function renderExtensionContent(ExtensionContentInterface $element): array
     {
-        $extension = $this->extensionRegistry->getExtensionForElement(FeedFormat::JSON, $element);
+        $extension = $this->extensionRegistry->getExtensionForContent(FeedFormat::JSON, $element);
         if (! $extension instanceof JsonExtensionInterface) {
             return [];
         }

diff --git a/Classes/Renderer/RssRenderer.php b/Classes/Renderer/RssRenderer.php
@@ -86,12 +86,12 @@ public function render(FeedInterface $feed, string $feedLink): string
         $textNode->add('generator', \sprintf('%s (%s)', Generator::NAME, Generator::URI));
         $imageNode->add($feed->getImage());
 
-        foreach ($feed->getExtensionElements() as $element) {
-            $extension = $this->extensionRegistry->getExtensionForElement(FeedFormat::RSS, $element);
+        foreach ($feed->getExtensionContents() as $content) {
+            $extension = $this->extensionRegistry->getExtensionForContent(FeedFormat::RSS, $content);
             if (! $extension instanceof XmlExtensionInterface) {
                 continue;
             }
-            $extension->getXmlRenderer()->render($element, $channelElement, $this->document);
+            $extension->getXmlRenderer()->render($content, $channelElement, $this->document);
             $this->usedExtensions[$extension->getQualifiedName()] = $extension->getNamespace();
         }
 

diff --git a/Tests/Fixtures/Entity/ItemFixture.php b/Tests/Fixtures/Entity/ItemFixture.php
@@ -61,7 +61,7 @@ public function getAttachments(): Collection
         return new Collection();
     }
 
-    public function getExtensionElements(): Collection
+    public function getExtensionContents(): Collection
     {
         return new Collection();
     }

diff --git a/Tests/Fixtures/FeedConfiguration/SomeFeed.php b/Tests/Fixtures/FeedConfiguration/SomeFeed.php
@@ -111,7 +111,7 @@ public function getStyleSheet(): string
         return '';
     }
 
-    public function getExtensionElements(): Collection
+    public function getExtensionContents(): Collection
     {
         return new Collection();
     }

diff --git a/Tests/Fixtures/Renderer/Atom/FullFeed.php b/Tests/Fixtures/Renderer/Atom/FullFeed.php
@@ -116,7 +116,7 @@ public function getStyleSheet(): string
         return '';
     }
 
-    public function getExtensionElements(): Collection
+    public function getExtensionContents(): Collection
     {
         return new Collection();
     }

diff --git a/Tests/Fixtures/Renderer/Rss/FullFeed.php b/Tests/Fixtures/Renderer/Rss/FullFeed.php
@@ -116,7 +116,7 @@ public function getStyleSheet(): string
         return '';
     }
 
-    public function getExtensionElements(): Collection
+    public function getExtensionContents(): Collection
     {
         return new Collection();
     }

diff --git a/...s/ValueObject/ExtensionElementFixture.php → ...s/ValueObject/ExtensionContentFixture.php b/...s/ValueObject/ExtensionElementFixture.php → ...s/ValueObject/ExtensionContentFixture.php
@@ -11,8 +11,8 @@
 
 namespace Brotkrueml\FeedGenerator\Tests\Fixtures\ValueObject;
 
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 
-final class ExtensionElementFixture implements ExtensionElementInterface
+final class ExtensionContentFixture implements ExtensionContentInterface
 {
 }
diff --git a/Tests/Unit/Collection/CollectionTest.php b/Tests/Unit/Collection/CollectionTest.php
@@ -13,7 +13,7 @@
 
 use Brotkrueml\FeedGenerator\Collection\Collection;
 use Brotkrueml\FeedGenerator\Collection\IndexNotFoundException;
-use Brotkrueml\FeedGenerator\Contract\ExtensionElementInterface;
+use Brotkrueml\FeedGenerator\Contract\ExtensionContentInterface;
 use Brotkrueml\FeedGenerator\Tests\Fixtures\Entity\ItemFixture;
 use Brotkrueml\FeedGenerator\Tests\Fixtures\ValueObject\AttachmentFixture;
 use Brotkrueml\FeedGenerator\Tests\Fixtures\ValueObject\AuthorFixture;
@@ -70,14 +70,14 @@ public function addAcceptsAnImplementationOfAuthorInterface(): void
     /**
      * @test
      */
-    public function addAcceptsAnImplementationOfExtensionElementInterface(): void
+    public function addAcceptsAnImplementationOfExtensionContentInterface(): void
     {
         self::expectNotToPerformAssertions();
 
-        $extensionElement = new class() implements ExtensionElementInterface {
+        $extensionContent = new class() implements ExtensionContentInterface {
         };
 
-        $this->subject->add($extensionElement);
+        $this->subject->add($extensionContent);
     }
 
     /**