✨ trash command (remove cache entries by key)

README.md

@@ -137,7 +137,7 @@ This plugin comes with a [few commands](https://github.com/bnomei/kirby3-janitor
 - `janitor:cleancontent`, removes fields from content file that are not defined in your blueprints
 - `janitor:clipboard`, copies a defined value to your clipboard
 - `janitor:download`, triggers a download of an URL
-- `janitor:flush`, flush a cache by providing its name
+- `janitor:flush`, flush a cache by providing its name (default: pages cache)
 - `janitor:job`, run a callback
 - `janitor:maintenance`, toggle maintenance mode
 - `janitor:open`, triggers opening of an URL in panel
@@ -146,6 +146,7 @@ This plugin comes with a [few commands](https://github.com/bnomei/kirby3-janitor
 - `janitor:render`, render a certain page or all pages (to create thumb jobs)
 - `janitor:thumbs`, process thumb jobs of a certain page or all pages
 - `janitor:tinker`, run a REPL session in terminal
+- `janitor:trash`, removes an entry from given cache by key or page (default: pages cache)
 - `janitor:undertaker`, backups a page and its subpages to a zip. You need to manually trigger it with a [hook](https://github.com/bnomei/kirby3-janitor/blob/master/tests/site/config/config.php).
 
 The plugin will register these commands starting with `janitor:*` automatically - no copying required.<br>But if you want to re-use any of the other example provided you need to copy them to your `site/commands`-folder

commands/trash.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+if (! class_exists('Bnomei\Janitor')) {
+    require_once __DIR__.'/../classes/Janitor.php';
+}
+
+use Bnomei\Janitor;
+use Kirby\CLI\CLI;
+
+/*
+ * PANEL:
+ * janitor:trash --name pages --key "home.en.html"
+ * janitor:trash --name pages --page "page://vf0xqIlpU0ZlSorI"
+ * janitor:trash --page "page://vf0xqIlpU0ZlSorI"
+ * janitor:trash
+ *
+ * CLI:
+ * env KIRBY_HOST=janitor.test vendor/bin/kirby janitor:trash --page "page://vf0xqIlpU0ZlSorI"
+ */
+return [
+    'description' => 'Removes an entry from a cache',
+    'args' => [
+        'name' => [
+            'prefix' => 'n',
+            'longPrefix' => 'name',
+            'description' => 'Name of the cache',
+            'defaultValue' => 'pages',
+        ],
+        'key' => [
+            'prefix' => 'k',
+            'longPrefix' => 'key',
+            'description' => 'Key for a cache entry',
+            'required' => false,
+        ],
+    ] + Janitor::ARGS, // page, file, user, site, data, model
+    'command' => static function (CLI $cli): void {
+        $name = $cli->arg('name');
+        $name = empty($name) ? 'pages' : $name;
+
+        $page = $cli->arg('page');
+        if ($page && $name === 'pages') {
+            if ($page = $cli->kirby()->page($page)) {
+                if ($cli->kirby()->multilang()) {
+                    foreach ($cli->kirby()->languages() as $language) {
+                        $cacheId = [$page->id(), $language->code()];
+                        if ($name === 'pages') {
+                            $cacheId[] = 'html'; // render content type
+                        }
+                        $cacheId = implode('.', $cacheId);
+                        $cli->kirby()->cache($name)->remove($cacheId);
+                        $cli->success('The entry "'.$cacheId.'" in the cache "'.$name.'" has been removed.');
+                    }
+                } else {
+                    $cacheId = [$page->id()];
+
+                    if ($name === 'pages') {
+                        $cacheId[] = 'html'; // render content type
+                    }
+
+                    $cacheId = implode('.', $cacheId);
+                    $cli->kirby()->cache($name)->remove($cacheId);
+                    $cli->success('The entry "'.$cacheId.'" in the cache "'.$name.'" has been removed.');
+                }
+
+                janitor()->data($cli->arg('command'), [
+                    'status' => 200,
+                ]);
+
+                return;
+            }
+        }
+
+        // if it has a key just remove that
+        if ($key = $cli->arg('key')) {
+            $cli->kirby()->cache($name)->remove($key);
+            $cli->success('The entry "'.$key.'" in the cache "'.$name.'" has been removed.');
+        }
+
+        janitor()->data($cli->arg('command'), [
+            'status' => 200,
+        ]);
+    },
+];

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "4.3.1",
+    "version": "4.4.0",
     "license": "MIT",
     "homepage": "https://github.com/bnomei/kirby3-janitor",
     "description": "Kirby Plugin for running commands like cleaning the cache from within the Panel, PHP code or a cronjob",

index.php

@@ -40,6 +40,7 @@
         'janitor:render' => require __DIR__.'/commands/render.php',
         'janitor:thumbs' => require __DIR__.'/commands/thumbs.php',
         'janitor:tinker' => require __DIR__.'/commands/tinker.php',
+        'janitor:trash' => require __DIR__.'/commands/trash.php',
         'janitor:undertaker' => require __DIR__.'/commands/undertaker.php',
     ],
     'fields' => [

tests/site/blueprints/pages/default.yml

@@ -25,6 +25,12 @@ fields:
     success: Pong
     error: BAMM
 
+  janitor_trash:
+    type: janitor
+    command: 'janitor:trash'
+    label: Removes Pages Cache for this page
+    icon: trash
+
   janitor_flushpages:
     type: janitor
     command: 'janitor:flush --name pages'

tests/site/config/config.php

@@ -4,6 +4,12 @@
     'debug' => true,
     'languages' => true,
 
+    'cache' => [
+        'pages' => [
+            'active' => true,
+        ],
+    ],
+
     'bnomei.janitor.secret' => 'e9fe51f94eadabf54',
 
     // janitor v2 job callback

vendor/composer/installed.php

@@ -1,8 +1,8 @@
 <?php return array(
     'root' => array(
         'name' => 'bnomei/kirby3-janitor',
-        'pretty_version' => '4.3.1',
-        'version' => '4.3.1.0',
+        'pretty_version' => '4.4.0',
+        'version' => '4.4.0.0',
         'reference' => null,
         'type' => 'kirby-plugin',
         'install_path' => __DIR__ . '/../../',
@@ -11,8 +11,8 @@
     ),
     'versions' => array(
         'bnomei/kirby3-janitor' => array(
-            'pretty_version' => '4.3.1',
-            'version' => '4.3.1.0',
+            'pretty_version' => '4.4.0',
+            'version' => '4.4.0.0',
             'reference' => null,
             'type' => 'kirby-plugin',
             'install_path' => __DIR__ . '/../../',