✨ added ->sitemap() support

Author: bnomei

README.md

@@ -1,4 +1,4 @@
-# Kirby 3 Feed
+# Kirby 3 Feed and Sitemap
 
 ![Release](https://flat.badgen.net/packagist/v/bnomei/kirby3-feed?color=ae81ff)
 ![Downloads](https://flat.badgen.net/packagist/dt/bnomei/kirby3-feed?color=272822)
@@ -7,7 +7,7 @@
 [![Maintainability](https://flat.badgen.net/codeclimate/maintainability/bnomei/kirby3-feed)](https://codeclimate.com/github/bnomei/kirby3-feed) 
 [![Twitter](https://flat.badgen.net/badge/twitter/bnomei?color=66d9ef)](https://twitter.com/bnomei)
 
-Generate a RSS/JSON-Feed from a Pages-Collection.
+Generate a RSS/JSON/Sitemap-Feed from a Pages-Collection.
 
 ## Commercial Usage
 
@@ -16,13 +16,21 @@ This plugin is free but if you use it in a commercial project please consider to
 - [buy me ☕](https://buymeacoff.ee/bnomei) or
 - [buy a Kirby license using this affiliate link](https://a.paddle.com/v2/click/1129/35731?link=1170)
 
+
+## Similar Plugins
+
+- [kirby3-xmlsitemap](https://github.com/omz13/kirby3-xmlsitemap)
+- [kirby3-feeds](https://github.com/omz13/kirby3-feeds)
+
+> both have not seen any updates since April 2019
+
 ## Installation
 
 - unzip [master.zip](https://github.com/bnomei/kirby3-feed/archive/master.zip) as folder `site/plugins/kirby3-feed` or
 - `git submodule add https://github.com/bnomei/kirby3-feed.git site/plugins/kirby3-feed` or
 - `composer require bnomei/kirby3-feed`
 
-## Usage
+## Usage Feed
 
 You can use this in a template for a dedicated feed page, in a template controller or a route.
 
@@ -75,8 +83,8 @@ return [
                 $feed = page('blog')->children()->listed()->flip()->limit(10)->feed($options);
                 return $feed;
             }
-        ]
-    ]
+        ],
+    ],
 ];
 ```
 
@@ -109,6 +117,55 @@ $feed = page('blog')->children()->listed()->sortBy(function ($page) {
 }, 'desc')->limit(10)->feed($options);
 ```
 
+## Usage Sitemap
+
+**options array defaults**
+
+If you use these defaults you need to provide the fields `date (type: date)` and `text (type: text)`.
+
+```php
+[
+    'urlfield' => 'url',
+    'titlefield' => 'title',
+    'textfield' => 'text',
+    'modified' => time(),
+    'snippet' => 'feed/sitemap'
+    'mime' => null,
+    'sort' => true,
+]
+```
+
+**virtual page in site/config.php**
+
+```php
+return [
+    'routes' => [
+        // ... other routes,
+        [
+            'pattern' => 'sitemap.xml',
+            'method' => 'GET',
+            'action'  => function () {
+                $options = [
+                    'images'       => false,
+                    'videos'       => false,
+                ];
+                $feed = site()->index()->listed()->limit(50000)->sitemap($options);
+                return $feed;
+            }
+        ],
+    ],
+];
+```
+
+**example for excluding pages from sitemap**
+
+see [Kirby Docs -Filtering compendium](https://getkirby.com/docs/cookbook/content/filtering)
+
+```php
+$feed = site()->index()->listed()->filterBy('template', '!=', 'excludeme')->limit(50000)->sitemap($options);
+```
+
+
 ## Settings
 
 | bnomei.feed.              | Default        | Description               |            

classes/Feed.php

@@ -115,6 +115,7 @@ private function modifiedHashFromKeys(): string
     public function optionsFromDefault(?Pages $pages = null, $options = []): array
     {
         $defaults = [
+            // json/rss
             'url' => site()->url(),
             'feedurl' => site()->url() . '/feed/',
             'title' => 'Feed',
@@ -128,6 +129,18 @@ public function optionsFromDefault(?Pages $pages = null, $options = []): array
             'snippet' => 'feed/rss',
             'mime' => null,
             'sort' => true,
+            // sitemap
+            'images' => false,
+            'imagesfield' => 'images',
+            'imagetitlefield' => 'title',
+            'imagecaptionfield' => 'caption',
+            'imagelicensefield' => 'license',
+            'videos' => false,
+            'videosfield' => 'videos',
+            'videotitlefield' => 'title',
+            'videothumbnailfield' => 'thumbnail',
+            'videodescriptionfield' => 'description',
+            'videourlfield' => 'url',
         ];
         $options = array_merge($defaults, $options);
 
@@ -160,6 +173,9 @@ public function response(): Response
 
         if ($mime !== null) {
             return new Response($this->string, $mime);
+        } 
+        elseif ($snippet === 'feed/sitemap' && Feed::isXml($this->string)) {
+            return new Response($this->string, 'xml');
         } elseif ($snippet === 'feed/json' || Feed::isJson($this->string)) {
             return new Response($this->string, 'json');
         } elseif ($snippet === 'feed/rss' || Feed::isXml($this->string)) {

composer.json

@@ -1,8 +1,8 @@
 {
   "name": "bnomei/kirby3-feed",
   "type": "kirby-plugin",
-  "version": "1.3.10",
-  "description": "Generate a RSS/JSON-Feed from a Pages-Collection",
+  "version": "1.4.0",
+  "description": "Generate a RSS/JSON/Sitemap-Feed from a Pages-Collection",
   "license": "MIT",
   "authors": [
     {
@@ -17,7 +17,8 @@
     "rss-feed",
     "rss",
     "feed",
-    "json"
+    "json",
+    "sitemap"
   ],
   "autoload": {
     "psr-4": {
@@ -62,7 +63,6 @@
   "suggest": {
     "bnomei/kirby3-htmlhead": "Best-practice HTML Head Element extendable with snippets.",
     "bnomei/kirby3-security-headers": "CPS headers to make the the web a saver place. Sensible defaults with zero configuration.",
-    "bnomei/kirby3-robots-txt": "Automatic robots.txt. Detects xmlsitemap.",
-    "omz13/kirby3-xmlsitemap": "Adds a xml sitemap"
+    "bnomei/kirby3-robots-txt": "Automatic robots.txt. Detects xmlsitemap."
   }
 }