Merge pull request #15 from TheDragonCode/1.x

Added `rootAttributes` method

Author: andrey-helldar

README.md

@@ -169,7 +169,7 @@ According to this example, the XML file with the following contents will be gene
 
 ### Objects, attributes and more
 
-#### Setting the name of the root element
+#### Setting the root element
 
 ```php
 class UserFeed extends Feed
@@ -178,6 +178,13 @@ class UserFeed extends Feed
     {
         return 'users';
     }
+    
+    public function rootAttributes(): array
+    {
+        return [
+            'foo' => 'some value',
+        ];
+    }
 }
 ```
 

src/Feeds/Feed.php

@@ -46,6 +46,11 @@ public function rootItem(): ?string
         return null;
     }
 
+    public function rootAttributes(): array
+    {
+        return [];
+    }
+
     public function filename(): string
     {
         return $this->filename ??= Str::kebab(class_basename($this)) . '.xml';

src/Feeds/Sitemaps/PostFeed.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Feeds\Sitemaps;
+
+use App\Models\Post;
+use DragonCode\LaravelFeed\Feeds\Feed;
+use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+class PostFeed extends Feed
+{
+    public function builder(): Builder
+    {
+        return Post::query()
+            ->withCount('comments')
+            ->with('author')
+            ->where('created_at', '>', now()->subYear());
+    }
+
+    public function rootItem(): ?string
+    {
+        return 'urlset';
+    }
+
+    public function filename(): string
+    {
+        return 'sitemaps/posts.xml';
+    }
+
+    public function item(Model $model): FeedItem
+    {
+        return new Items\Sitemaps\PostFeedItem($model);
+    }
+}

src/Services/Generator.php

@@ -8,11 +8,13 @@
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Filesystem\Filesystem;
 
+use function collect;
 use function dirname;
 use function fclose;
 use function fopen;
 use function fwrite;
 use function implode;
+use function sprintf;
 
 class Generator
 {
@@ -55,7 +57,9 @@ protected function performHeader($file, Feed $feed): void
         $value = $feed->header();
 
         if ($item = $feed->rootItem()) {
-            $value .= "\n<$item>\n";
+            $value .= $feed->rootAttributes()
+                ? sprintf("\n<%s %s>\n", $item, $this->makeRootAttributes($feed))
+                : sprintf("\n<%s>\n", $item);
         }
 
         $this->append($file, $value);
@@ -72,6 +76,13 @@ protected function performFooter($file, Feed $feed): void
         $this->append($file, $value);
     }
 
+    protected function makeRootAttributes(Feed $feed): string
+    {
+        return collect($feed->rootAttributes())
+            ->map(fn (mixed $value, int|string $key) => sprintf('%s="%s"', $key, $value))
+            ->implode(' ');
+    }
+
     protected function append($file, string $content): void
     {
         if (! empty($content)) {