Make template for converted images optional

fundevogel · Oct 18, 2020 · 30a8a47 · 30a8a47
1 parent 2c101d8
commit 30a8a47
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ You may also change certain options from your `config.php` globally, like this:
 | `'hlglum'`   | integer     | `null`                      | Like `'deflum'`, but uses an appropriate diffuse white based on peak HLG               |
 | `'jobs'`     | integer     | `0`                         | Number of jobs to use when working (`0` = unlimited)                                   |
 | `'speed'`    | integer     | `'auto'`                    | Quality/speed tradeoff when encoding (AVIF only); `0` = best quality, `10` = fastest   |
-| `'template'` | string      | `'image'`                   | Set file blueprint for generated images                                                |
+| `'template'` | string      | `null`                      | Set file blueprint for images generated with `toFormat()`                              |
 | `'tonemap'`  | string|bool | `'auto'`                    | Set tonemapping (`'on'` or `'off'`, but `true` & `false` are possible, too)            |
 | `'yuv'`      | string      | `'auto'`                    | Choose yuv output format for supported formats (`'444'`, `'422'`, `'420'` or `'yv12'`) |
 
@@ -110,6 +110,20 @@ return [
 $image->toFormat('avif')->thumb(['width' => 300]);
 ```
 
+**Note:** You may also define [file templates](https://getkirby.com/docs/reference/panel/blueprints/file) on a per-format basis:
+
+```php
+// config.php
+
+return [
+    // ..
+    'fundevogel.colorist.template' => [
+        'avif' => 'early-bird',
+        'webp' => 'google-lover',
+    ],
+];
+```
+
 #### Methods
 For now, the following methods are available:
 

diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
     "description": "Kirby v3 wrapper for colorist",
     "type": "kirby-plugin",
     "license": "MIT",
-    "version": "1.6.1",
+    "version": "1.6.2",
     "keywords": ["kirby3", "image", "graphics"],
     "homepage": "https://github.com/Fundevogel/kirby3-colorist#readme",
     "authors": [

diff --git a/index.php b/index.php
@@ -42,7 +42,7 @@
     'options' => [
         'bin' => __DIR__ . '/bin/colorist',
         'sizes' => [1920, 1140, 640, 320],
-        'template' => 'image',
+        'template' => null,
         'formats' => ['webp'],
     ],
     'snippets' => [
@@ -124,23 +124,30 @@
             $src = $this->root();
             $dst = Str::replace($src, $oldName, $newName);
 
+            $fileOptions = [
+                'source' => $dst,
+                'parent' => $this->parent(),
+                'filename' => $newName,
+            ];
+
             $template = option('fundevogel.colorist.template');
 
-            # Check if there's an array with a template for each format
-            if (is_array($template)) {
-                if (!isset($template[$format])) {
-                    throw new Exception('No valid file template specified for format "' . $format . '"');
+            # Check if template should be applied
+            if ($template !== null) {
+                # Check if there's an array with a template for each format
+                if (is_array($template)) {
+                    if (!array_key_exists($format, $template)) {
+                        throw new Exception('No valid file template specified for format "' . $format . '"');
+                    }
+
+                    $template = $template[$format];
                 }
 
-                $template = $template[$format];
+                # Apply template
+                $fileOptions['template'] = $template;
             }
 
-            $file = new File([
-                'source' => $dst,
-                'parent' => $this->parent(),
-                'filename' => $newName,
-                'template' => $template,
-            ]);
+            $file = new File($fileOptions);
 
             if ($file->exists()) {
                 return $file;