Merge pull request #110 from bnomei/call-job-on-model

call job on model

Author: bnomei

.gitignore

@@ -34,3 +34,4 @@ node_modules
 /vendor/**/php4/*
 /vendor/getkirby/composer-installer
 
+/tests/site/backups/

README.md

@@ -132,6 +132,7 @@ The `$model` will match the model of whatever page, file, user or site object yo
 This plugin comes with a [few commands](https://github.com/bnomei/kirby3-janitor/tree/master/commands) you might like to use yourself and some [example commands](https://github.com/bnomei/kirby3-janitor/tree/master/tests/site/commands) used to showcase the various options the button has (like how to change the icon or open a URL in a new tab). Some commands can be used in both panel and terminal. Others are limited in their use to either one of them. In the terminal you can use `--help` argument to view the help for each command.
 
 - `janitor:backupzip`, creates a backup zip
+- `janitor:call`, calls a method on the current model with optional data parameter
 - `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
@@ -234,11 +235,16 @@ janitor_thumbssite:
   type: janitor
   command: 'janitor:thumbs --site'
   label: Generate thumbs from existing thumb jobs (full site)
+
+janitor_callWithData:
+	label: Call method on model with Data
+	type: janitor
+	command: 'janitor:call --method repeatAfterMe --data {{ user.id }}'
 ```
 
 If you want you can also call any of [the core shipping with the CLI](https://github.com/getkirby/cli#available-core-commands) like `clear:cache`.
 
-Keep in mind that the Janitor panel button will append the `--quiet` option on all commands automatically to silence outputs to the non-existing CLI.
+Keep in mind that the Janitor panel button and webhooks will append the `--quiet` option on all commands automatically to silence outputs to the non-existing CLI. But if you use `janitor()->command()` you will have to append `--quiet` to your command yourself.
 
 ### Smartly delaying resolution of a command argument
 

commands/call.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types = 1);
+
+if (!class_exists('Bnomei\Janitor')) {
+	require_once __DIR__ . '/../classes/Janitor.php';
+}
+
+use Bnomei\Janitor;
+use Kirby\CLI\CLI;
+
+return [
+	'description' => 'Call a job-like method on a model',
+	'args' => [
+		'method' => [
+			'longPrefix' => 'method',
+			'description' => 'Name of the method on the model',
+			'castTo' => 'string',
+			'required' => true,
+		],
+	] + Janitor::ARGS, // page, file, user, site, data, model
+	'command' => static function (CLI $cli): void {
+		$method = $cli->arg('method');
+		$result = [
+			'status' => 500,
+		];
+
+		$model = null;
+		if ($cli->arg('site')) {
+			$model = $cli->kirby()->site();
+		} elseif (!empty($cli->arg('page'))) {
+			$model = $cli->kirby()->page($cli->arg('page'));
+		} elseif (!empty($cli->arg('file'))) {
+			$model = $cli->kirby()->file($cli->arg('file'));
+		} elseif (!empty($cli->arg('user'))) {
+			$model = $cli->kirby()->user($cli->arg('user'));
+		}
+
+		if ($model) {
+			if (method_exists($model, $method)) {
+				if (empty($cli->arg('data'))) {
+					$result = $model->$method();
+				} else {
+					$result = $model->$method($cli->arg('data'));
+				}
+			} else {
+				$result['message'] = t('janitor.method-not-found', 'Method "' . $method . '" could not be called on model of class <' . $model::class . '>.');
+			}
+		} else {
+			$result['message'] = t('janitor.model-not-found', 'No model provided');
+			$cli->error('No model provided. Use `--page`, `--file`, `--user` or `--site`.');
+		}
+
+		(A::get($result, 'status') === 200 ? $cli->success($model::class . '->' . $method) : $cli->error($model::class . '->' . $method));
+		$cli->out(print_r($result, true));
+
+		janitor()->data($cli->arg('command'), $result);
+	}
+];

composer.json

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

index.php

@@ -23,6 +23,7 @@
 	],
 	'commands' => [ // https://github.com/getkirby/cli
 		'janitor:backupzip' => require __DIR__ . '/commands/backupzip.php',
+		'janitor:call' => require __DIR__ . '/commands/call.php',
 		'janitor:cleancontent' => require __DIR__ . '/commands/cleancontent.php',
 		'janitor:clipboard' => require __DIR__ . '/commands/clipboard.php',
 		'janitor:download' => require __DIR__ . '/commands/download.php',

tests/JanitorTest.php

@@ -54,4 +54,18 @@ public function testJob()
 			$janitor->command('janitor:job  --key some.key.to.task --site --data "some data"')['message']
 		);
 	}
+
+	public function testMethod()
+	{
+		$janitor = new Janitor();
+		$this->assertEquals(
+			200,
+			$janitor->command('janitor:call --method whoAmI --page page://vf0xqIlpU0ZlSorI')['status']
+		);
+
+		$this->assertEquals(
+			'Repeat after me: hello',
+			$janitor->command('janitor:call --method repeatAfterMe --data hello --page page://vf0xqIlpU0ZlSorI')['message']
+		);
+	}
 }