Init

Author: lukaskleinschmidt

.editorconfig

@@ -0,0 +1,20 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.php]
+indent_size = 4
+
+[*.md,*.txt]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[composer.json]
+indent_size = 4

.gitattributes

@@ -0,0 +1,11 @@
+# Note: You need to uncomment the lines you want to use; the other lines can be deleted
+
+# Git
+# .gitattributes export-ignore
+# .gitignore export-ignore
+
+# Tests
+# /.coveralls.yml export-ignore
+# /.travis.yml export-ignore
+# /phpunit.xml.dist export-ignore
+# /tests/ export-ignore

.gitignore

@@ -0,0 +1,8 @@
+# OS files
+.DS_Store
+
+# npm modules
+/node_modules
+
+# Composer files
+/vendor

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Lukas Kleinschmidt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,98 @@
+# Kirby Snippet Controller
+Define snippet controllers in a similar way how page controllers work.
+By default the plugin will try to find controllers in your `snippets` directory.
+Lets have a look at a example `header` snippet.
+
+## How to use it
+```bash
+📁 snippets
+├─ 📄 header.controller.php
+└─ 📄 header.php
+```
+
+```php
+// header.controller.php
+
+// The return value can be a callback
+return function ($site) {
+    return [
+        'title' => $site->title(),
+    ];
+};
+
+// Or you can simply return an array.
+return [
+    'value' => site()->title(),
+];
+
+```
+
+You can also define controllers in a plugin.
+```php
+Kirby::plugin('superwoman/superplugin', [
+    'snippets' => [
+
+        // Refer to a file
+        'header.controller' => __DIR__ . '/snippets/header.controller.php',
+
+        // Return an array
+        'header.controller' => [
+            'title' => site()->title(),
+        ],
+
+        // Return a callback
+        'header.controller' => function ($site) {
+            return [
+                'title' => $site->title(),
+            ];
+        },
+
+    ],
+]);
+```
+
+### Available callback arguments in your controllers
+Like in regular controllers, you can access the `$site`, `$page`, `$pages` and `$kirby` objects by loading them as arguments to the anonymous function. The plugin will inject the right objects for you. In addition, you also have access to the `$data` argument, which contains the data you passed to the snippet.
+
+### Naming convention
+By default, the plugin searches for controllers by appending `.controller` to the snippet name. You can change the name resolver in the options. Changing the name also affects plugin-defined controllers.
+```php
+// config.php
+
+return [
+    'lukaskleinschmidt.snippet-controller' => [
+
+        // The default resolver
+        'name' => fn (string $name) => $name . '.controller',
+
+        // You might want to store controllers in a separate folder
+        'name' => fn (string $name) => 'controllers/' . $name,
+
+    ],
+];
+
+```
+
+## Commercial Usage
+This plugin is free. Please consider to [make a donation](https://www.paypal.me/lukaskleinschmidt/5EUR) if you use it in a commercial project.
+
+## Installation
+
+### Download
+Download and copy this repository to `/site/plugins/snippet-controller`.
+
+### Git submodule
+```
+git submodule add https://github.com/lukaskleinschmidt/kirby-snippet-controller.git site/plugins/snippet-controller
+```
+
+### Composer
+```
+composer require lukaskleinschmidt/kirby-snippet-controller
+```
+
+## License
+MIT
+
+## Credits
+- [Lukas Kleinschmidt](https://github.com/lukaskleinschmidt)

composer.json

@@ -0,0 +1,21 @@
+{
+	"name": "lukaskleinschmidt/kirby-snippet-controller",
+	"description": "Kirby Snippet Controller",
+	"license": "MIT",
+	"type": "kirby-plugin",
+	"version": "1.0.0",
+	"authors": [
+		{
+			"name": "Lukas Kleinschmidt",
+			"email": "[email protected]"
+		}
+	],
+	"require": {
+		"getkirby/composer-installer": "^1.2"
+	},
+	"config": {
+		"allow-plugins": {
+			"getkirby/composer-installer": true
+		}
+	}
+}

composer.lock

@@ -0,0 +1,57 @@
+<?php
+
+use Kirby\Cms\App;
+use Kirby\Filesystem\F;
+use Kirby\Toolkit\A;
+use Kirby\Toolkit\Controller;
+
+if (! function_exists('snippet_controller_value')) {
+    function snippet_controller_value(string|array $name): mixed
+    {
+        $kirby = App::instance();
+		$names = A::wrap($name);
+        $root = $kirby->root('snippets');
+
+		foreach ($names as $name) {
+			$name = $kirby->option('lukaskleinschmidt.snippet-controller.name')($name, $kirby);
+			$file = $root . '/' . $name . '.php';
+
+			if (file_exists($file) === false) {
+				$file = $kirby->extensions('snippets')[$name] ?? null;
+			}
+
+			if ($file) {
+				break;
+			}
+		}
+
+        return $file;
+    }
+}
+
+if (! function_exists('snippet_controller')) {
+    function snippet_controller(string|array $name, array $data = []): array
+    {
+        if (is_null($value = snippet_controller_value($name))) {
+            return $data;
+        }
+
+        if (is_string($value) && is_file($value)) {
+            $value = F::load($value);
+        }
+
+        if ($value instanceof Closure) {
+            $kirby = App::instance();
+
+            $value = (new Controller($value))->call($kirby, [
+                'kirby' => $kirby,
+                'site'  => $site = $kirby->site(),
+                'pages' => $site->children(),
+                'page'  => $site->page(),
+                'data'  => $data,
+            ]);
+        }
+
+        return is_array($value) ? array_merge($value, $data) : $data;
+    }
+}

helpers.php

@@ -0,0 +1,23 @@
+<?php
+
+use Kirby\Cms\App;
+
+@include_once __DIR__ . '/helpers.php';
+
+App::plugin('lukaskleinschmidt/snippet-controller', [
+    'options' => [
+        'name' => fn (string $name) => $name . '.controller',
+    ],
+    'components' => [
+        'snippet' => function (App $kirby, $name, array $data = [], bool $slots = false) {
+            $data = snippet_controller($name, $data);
+
+            return $kirby->core()->components()['snippet'](
+                $kirby,
+                $name,
+                $data,
+                $slots,
+            );
+        }
+    ],
+]);