Docs: use attributes by default

orisai · Jan 1, 2025 · 13c3e0b · 13c3e0b
1 parent 162fede
commit 13c3e0b
Show file tree

Hide file tree

Showing 2 changed files with 95 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,47 @@
 
 ##
 
+<details open>
+	<summary>Attributes definition</summary>
+
+```php
+use Orisai\ObjectMapper\MappedObject;
+use Orisai\ObjectMapper\Rules\MappedObjectValue;
+use Orisai\ObjectMapper\Rules\StringValue;
+
+final class UserInput implements MappedObject
+{
+
+	#[StringValue(notEmpty=true)]
+	public string $firstName;
+
+	#[StringValue(notEmpty=true)]
+	public string $lastName;
+
+	#[MappedObjectValue(UserAddressInput::class)]
+	public UserAddressInput $address;
+
+}
+```
+
+```php
+use Orisai\ObjectMapper\MappedObject;
+use Orisai\ObjectMapper\Rules\StringValue;
+
+final class UserAddressInput implements MappedObject
+{
+
+	#[StringValue(notEmpty=true)]
+	public string $street;
+
+	// ...
+}
+```
+</details>
+
+<details>
+	<summary>Annotations definition</summary>
+
 ```php
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\MappedObjectValue;
@@ -62,6 +103,10 @@ final class UserAddressInput implements MappedObject
 	// ...
 }
 ```
+</details>
+
+<details open>
+	<summary>Processing</summary>
 
 ```php
 use Orisai\ObjectMapper\Exception\InvalidData;
@@ -90,3 +135,4 @@ try {
 
 echo "User name is: {$user->firstName} {$user->lastName}";
 ```
+</details>
diff --git a/docs/README.md b/docs/README.md
@@ -111,6 +111,29 @@ installation.
 
 After you have finished [setup](#setup), define a mapped object:
 
+<details open>
+	<summary>Either with attributes</summary>
+
+```php
+use Orisai\ObjectMapper\MappedObject;
+use Orisai\ObjectMapper\Rules\StringValue;
+
+final class UserInput implements MappedObject
+{
+
+	#[StringValue(notEmpty=true)]
+	public string $firstName;
+
+	#[StringValue(notEmpty=true)]
+	public string $lastName;
+
+}
+```
+</details>
+
+<details>
+	<summary>Or doctrine/annotations</summary>
+
 ```php
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\StringValue;
@@ -124,7 +147,9 @@ final class UserInput implements MappedObject
 	/** @StringValue(notEmpty=true) */
 	public string $lastName;
 
+}
 ```
+</details>
 
 Map data to the object:
 
@@ -209,6 +234,29 @@ $input = $processor->process($data, WithAnnotationsAndAttributesInput::class); /
 
 Expects bool
 
+<details open>
+	<summary><code>#[Attributes()]</code></summary>
+
+```php
+use Orisai\ObjectMapper\MappedObject;
+use Orisai\ObjectMapper\Rules\BoolValue;
+
+final class BoolInput implements MappedObject
+{
+
+    #[BoolValue()]
+    public bool $field;
+
+    #[BoolValue(castBoolLike=true)]
+    public bool $anotherField;
+
+}
+```
+</details>
+
+<details>
+	<summary><code>@Annotations()</code></summary>
+
 ```php
 use Orisai\ObjectMapper\MappedObject;
 use Orisai\ObjectMapper\Rules\BoolValue;
@@ -224,6 +272,7 @@ final class BoolInput implements MappedObject
 
 }
 ```
+</details>
 
 ```php
 $data = [