Add ValidProps formatters

Author: rozsival

composer.json

@@ -35,6 +35,7 @@
   },
   "require": {
     "php": ">=7.4",
+    "ext-json": "*",
     "nette/application": "^3.0",
     "nette/schema": "^1.0",
     "wavevision/utils": "^2.5"

docs/_coverpage.md

@@ -1,5 +1,5 @@
 <a href="https://github.com/wavevision"><img alt="Wavevision s.r.o." src="https://wavevision.com/images/wavevision-logo.png" width="120" /></a>
-<h1>PropsControl <small>6.0.0</small></h1>
+<h1>PropsControl <small>6.2.0</small></h1>
 
 > Create smart UI components for [@nette](https://github.com) framework.
 

docs/guide/working-with-props.md

@@ -1,14 +1,14 @@
 # Working with Props
 
-As demonstrated in [First Component](getting-started/first-component.md) example, each `PropsControl` component needs its
-Props for data consumption and output rendering.
+As demonstrated in [First Component](getting-started/first-component.md) example, each `PropsControl` component needs
+its Props for data consumption and output rendering.
 
 ## Definition
 
-The definition will give us the shape of our props, so we can structure and validate them. 
-Also, the constants used for the definition can be later used to create and get the data while avoiding typos in prop names.
-Constants are also extremely useful when re-defining your props. If you refactor any constant in your IDE, the change will
-get propagated through your whole application.
+The definition will give us the shape of our props, so we can structure and validate them. Also, the constants used for
+the definition can be later used to create and get the data while avoiding typos in prop names. Constants are also
+extremely useful when re-defining your props. If you refactor any constant in your IDE, the change will get propagated
+through your whole application.
 
 After we created our definition and linked it to our component we can use the definition object to wrap our data.
 
@@ -64,3 +64,11 @@ Props are read-only, `Wavevision\PropsControl\Exceptions\NotAllowed` exception w
 - you're trying to access an undefined prop
 - you're trying to write to a prop
 - you're calling any method not defined in `Wavevision\PropsControl\ValidProps` class
+
+## Formatting props
+
+You can use a few predefined methods to format values of the `ValidProps` object.
+
+- `toArray(): array<mixed>`
+- `toArrayHash(): Nette\Utils\ArrayHash<mixed>`
+- `toJson(): string`

src/PropsControl/ValidProps.php

@@ -2,6 +2,8 @@
 
 namespace Wavevision\PropsControl;
 
+use Nette\Utils\ArrayHash;
+use Nette\Utils\Json;
 use stdClass;
 use Wavevision\PropsControl\Exceptions\NotAllowed;
 use function array_key_exists;
@@ -55,6 +57,27 @@ public function getProps(): Props
 		return $this->props;
 	}
 
+	/**
+	 * @return array<mixed>
+	 */
+	public function toArray(): array
+	{
+		return $this->values;
+	}
+
+	/**
+	 * @return ArrayHash<mixed>
+	 */
+	public function toArrayHash(): ArrayHash
+	{
+		return ArrayHash::from($this->toArray());
+	}
+
+	public function toJson(): string
+	{
+		return Json::encode($this->toArray());
+	}
+
 	/**
 	 * @param mixed[] $arguments
 	 */

tests/PropsControlTests/ValidPropsTest.php

@@ -2,6 +2,7 @@
 
 namespace Wavevision\PropsControlTests;
 
+use Nette\Utils\ArrayHash;
 use PHPUnit\Framework\TestCase;
 use Wavevision\PropsControl\Exceptions\NotAllowed;
 use Wavevision\PropsControl\ValidProps;
@@ -33,6 +34,26 @@ public function testGetProps(): void
 		$this->assertSame($props, $validProps->getProps());
 	}
 
+	public function testToArray(): void
+	{
+		$props = [];
+		$validProps = new ValidProps(new TestComponentProps(), $props);
+		$this->assertSame($validProps->toArray(), $props);
+	}
+
+	public function testToArrayHash(): void
+	{
+		$props = ['prop' => 'value'];
+		$validProps = new ValidProps(new TestComponentProps(), $props);
+		$this->assertEquals(ArrayHash::from($props), $validProps->toArrayHash());
+	}
+
+	public function testToJson(): void
+	{
+		$validProps = new ValidProps(new TestComponentProps(), []);
+		$this->assertIsString($validProps->toJson());
+	}
+
 	public function testGetThrowsNotAllowed(): void
 	{
 		$validProps = new ValidProps(new TestComponentProps(), ['prop' => 'value']);