✨ job/call now support void/bool/string returns

allow jobs from config files and model methods to yield void/bool/string instead of janitor data-array

Signed-off-by: bnomei <[email protected]>

Author: bnomei

commands/call.php

@@ -43,6 +43,19 @@
 				} else {
 					$result = $model->$method($cli->arg('data'));
 				}
+				if (is_null($result)) {
+					$result = [];
+					$result['status'] = 200;
+				} elseif (is_bool($result)) {
+					$result = [];
+					$result['status'] = $result ? 200 : 204;
+				} elseif (is_string($result)) {
+					$result = [];
+					$result = [
+						'status' => 200,
+						'message' => $result,
+					];
+				}
 			} else {
 				$result['message'] = t('janitor.method-not-found', 'Method "' . $method . '" could not be called on model of class <' . $model::class . '>.');
 			}

commands/job.php

@@ -43,6 +43,19 @@
 				} else {
 					$result = $job($model, $cli->arg('data'));
 				}
+				if (is_null($result)) {
+					$result = [];
+					$result['status'] = 200;
+				} elseif (is_bool($result)) {
+					$result = [];
+					$result['status'] = $result ? 200 : 204;
+				} elseif (is_string($result)) {
+					$result = [];
+					$result = [
+						'status' => 200,
+						'message' => $result,
+					];
+				}
 			} else {
 				$result['message'] = t('janitor.job-not-found', 'Job "' . $key . '" could not be found.');
 			}

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "3.7.0",
+    "version": "3.8.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",

composer.lock

@@ -67,5 +67,15 @@ public function testMethod()
 			'Repeat after me: hello',
 			$janitor->command('janitor:call --method repeatAfterMe --data hello --page page://vf0xqIlpU0ZlSorI')['message']
 		);
+
+		$this->assertEquals(
+			200,
+			$janitor->command('janitor:call --method nullberry --page page://vf0xqIlpU0ZlSorI')['status']
+		);
+
+		$this->assertEquals(
+			204,
+			$janitor->command('janitor:call --method boolberry --page page://vf0xqIlpU0ZlSorI')['status']
+		);
 	}
 }

tests/JanitorTest.php

@@ -2,6 +2,18 @@
 
 class DefaultPage extends \Kirby\Cms\Page
 {
+	public function nullberry(): void
+	{
+		// will yield 200 automatically
+	}
+
+	public function boolberry(): bool
+	{
+		// will yield 200/204 automatically
+		return false;
+	}
+
+
 	public function whoAmI(): array
 	{
 		return [

tests/site/models/default.php

@@ -1,8 +1,8 @@
 <?php return array(
     'root' => array(
         'name' => 'bnomei/kirby3-janitor',
-        'pretty_version' => '3.7.0',
-        'version' => '3.7.0.0',
+        'pretty_version' => '3.8.0',
+        'version' => '3.8.0.0',
         'reference' => NULL,
         'type' => 'kirby-plugin',
         'install_path' => __DIR__ . '/../../',
@@ -11,8 +11,8 @@
     ),
     'versions' => array(
         'bnomei/kirby3-janitor' => array(
-            'pretty_version' => '3.7.0',
-            'version' => '3.7.0.0',
+            'pretty_version' => '3.8.0',
+            'version' => '3.8.0.0',
             'reference' => NULL,
             'type' => 'kirby-plugin',
             'install_path' => __DIR__ . '/../../',