feature: getBodyJson

Author: Greg Bowler

src/Input.php

@@ -3,7 +3,9 @@
 
 use ArrayAccess;
 use Countable;
+use Gt\Json\JsonDecodeException;
 use Gt\Json\JsonObject;
+use Gt\Json\JsonObjectBuilder;
 use Iterator;
 use Psr\Http\Message\StreamInterface;
 use Gt\Input\Trigger\Trigger;
@@ -46,7 +48,7 @@ public function __construct(
 		array $get = [],
 		array $post = [],
 		array $files = [],
-		string $bodyPath = "php://input"
+		string $bodyPath = "php://input",
 	) {
 		$this->bodyStream = new BodyStream($bodyPath);
 
@@ -194,6 +196,17 @@ public function getAll(?string $method = null):InputData {
 		}
 	}
 
+	public function getBodyJson():?JsonObject {
+		$jsonBuilder = new JsonObjectBuilder();
+
+		try {
+			return $jsonBuilder->fromJsonString($this->bodyStream->getContents());
+		}
+		catch(JsonDecodeException) {
+			return null;
+		}
+	}
+
 	/**
 	 * Return a "do" Trigger, matching when a request variable is present with the
 	 * provided $match value.
@@ -250,9 +263,4 @@ protected function newTrigger(string $functionName, string...$args):Trigger {
 		$trigger = new Trigger($this);
 		return $trigger->$functionName(...$args);
 	}
-
-	public function getBodyJson():?JsonObject {
-		return null;
-	}
-
 }

test/phpunit/InputTest.php

@@ -11,6 +11,9 @@
 use Gt\Input\MissingInputParameterException;
 use Gt\Input\Test\Helper\Helper;
 use Gt\Input\Trigger\Trigger;
+use Gt\Json\JsonObject;
+use Gt\Json\JsonPrimitive\JsonArrayPrimitive;
+use Gt\Json\JsonPrimitive\JsonStringPrimitive;
 use PHPUnit\Framework\TestCase;
 
 class InputTest extends TestCase {
@@ -672,6 +675,41 @@ public function testGetBodyJson_notJson():void {
 		self::assertNull($json);
 	}
 
+	public function testGetBodyJson_string():void {
+		$inputPath = tempnam(sys_get_temp_dir(), "phpgt-input-test-");
+		file_put_contents($inputPath, "\"Hello, PHP.Gt!\"");
+		$sut = new Input(bodyPath: $inputPath);
+		$json = $sut->getBodyJson();
+		self::assertInstanceOf(JsonStringPrimitive::class, $json);
+		self::assertSame("Hello, PHP.Gt!", $json->getPrimitiveValue());
+	}
+
+	public function testGetBodyJson_arrayWithObject():void {
+		$inputPath = tempnam(sys_get_temp_dir(), "phpgt-input-test-");
+		file_put_contents($inputPath, "[1, 2, 3, {\"name\": \"Cody\"}]");
+		$sut = new Input(bodyPath: $inputPath);
+		$json = $sut->getBodyJson();
+		self::assertInstanceOf(JsonArrayPrimitive::class, $json);
+		$array = $json->getPrimitiveValue();
+		self::assertSame(1, $array[0]);
+		self::assertSame(2, $array[1]);
+		self::assertSame(3, $array[2]);
+		/** @var JsonObject $thirdArrayElement */
+		$thirdArrayElement = $array[3];
+		self::assertInstanceOf(JsonObject::class, $thirdArrayElement);
+		self::assertSame("Cody", $thirdArrayElement->getString("name"));
+	}
+
+	public function testGetBodyJson_withQueryString():void {
+		$inputPath = tempnam(sys_get_temp_dir(), "phpgt-input-test-");
+		file_put_contents($inputPath, "\"Hello, PHP.Gt!\"");
+		$sut = new Input(["id" => 123], bodyPath: $inputPath);
+		$json = $sut->getBodyJson();
+		self::assertInstanceOf(JsonStringPrimitive::class, $json);
+		self::assertSame("Hello, PHP.Gt!", $json->getPrimitiveValue());
+		self::assertSame(123, $sut->getInt("id"));
+	}
+
 	public static function dataRandomGetPost():array {
 		$data = [];