docs: Updated Documentation of Library

Author: usernane

README.md

@@ -0,0 +1,16 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+
+// Quick init via constructor
+$json = new Json([
+    'name'    => 'Ibrahim',
+    'age'     => 30,
+    'married' => false,
+    'score'   => 9.5,
+    'notes'   => null,
+]);
+
+echo $json . "\n";
+// {"name":"Ibrahim","age":30,"married":false,"score":9.5,"notes":null}

examples/01-basic-usage.php

@@ -0,0 +1,11 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+
+$json = new Json();
+$json->addArray('tags', ['php', 'json', 'api']);
+$json->addArray('address', ['city' => 'Riyadh', 'country' => 'SA'], true); // true = as object
+
+echo $json . "\n";
+// {"tags":["php","json","api"],"address":{"city":"Riyadh","country":"SA"}}

examples/02-arrays.php

@@ -0,0 +1,23 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+use WebFiori\Json\JsonI;
+
+class User implements JsonI {
+    public function __construct(
+        private string $username,
+        private string $email
+    ) {}
+
+    public function toJSON(): Json {
+        return new Json(['username' => $this->username, 'email' => $this->email]);
+    }
+}
+
+$json = new Json();
+$user = new User('ibrahim', 'ibrahim@example.com');
+$json->addObject('user', $user);
+
+echo $json . "\n";
+// {"user":{"username":"ibrahim","email":"ibrahim@example.com"}}

examples/03-object-with-jsoni.php

@@ -0,0 +1,26 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+
+class Product {
+    public string $sku = 'ABC-001';
+    private string $name;
+    private float $price;
+
+    public function __construct(string $name, float $price) {
+        $this->name  = $name;
+        $this->price = $price;
+    }
+
+    public function getName(): string { return $this->name; }
+    public function getPrice(): float { return $this->price; }
+}
+
+$json = new Json();
+$product = new Product('Keyboard', 49.99);
+$json->addObject('product', $product);
+
+echo $json . "\n";
+// {"product":{"Name":"Keyboard","Price":49.99,"sku":"ABC-001"}}
+// ^ getters produce "Name"/"Price", public property adds "sku"

examples/04-object-auto-mapping.php

@@ -0,0 +1,16 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+
+$data = ['first-name' => 'Ibrahim', 'last-name' => 'Al-Shikh'];
+
+echo new Json($data, 'none')  . "\n"; // {"first-name":"Ibrahim","last-name":"Al-Shikh"}
+echo new Json($data, 'camel') . "\n"; // {"firstName":"Ibrahim","lastName":"Al-Shikh"}
+echo new Json($data, 'snake') . "\n"; // {"first_name":"Ibrahim","last_name":"Al-Shikh"}
+echo new Json($data, 'kebab') . "\n"; // {"first-name":"Ibrahim","last-name":"Al-Shikh"}
+
+// Change style after construction + apply upper case
+$json = new Json($data);
+$json->setPropsStyle('snake', 'upper');
+echo $json . "\n"; // {"FIRST_NAME":"Ibrahim","LAST_NAME":"Al-Shikh"}

examples/05-naming-styles.php

@@ -0,0 +1,20 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+use WebFiori\Json\JsonException;
+
+// Decode a JSON string
+$json = Json::decode('{"name":"Ibrahim","age":30}');
+echo $json->get('name') . "\n"; // Ibrahim
+echo $json->get('age')  . "\n"; // 30
+
+// Read from file
+try {
+    $json = Json::fromJsonFile(__DIR__ . '/sample.json');
+    echo $json->get('product') . "\n"; // Keyboard
+    echo $json->get('price')   . "\n"; // 49.99
+    echo ($json->get('inStock') ? 'true' : 'false') . "\n"; // true
+} catch (JsonException $e) {
+    echo 'Error: ' . $e->getMessage() . "\n";
+}

examples/06-decode-and-read.php

@@ -0,0 +1,12 @@
+<?php
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use WebFiori\Json\Json;
+
+$json = new Json([
+    'name'       => 'Ibrahim',
+    'age'        => 30,
+    'isEmployed' => true,
+]);
+
+echo $json->toJSONxString() . "\n";

examples/07-jsonx.php

@@ -0,0 +1,17 @@
+# Examples
+
+| File | What it shows |
+|------|---------------|
+| [01-basic-usage.php](01-basic-usage.php) | Constructor init, scalar types, `echo` output |
+| [02-arrays.php](02-arrays.php) | Indexed arrays, associative arrays as objects |
+| [03-object-with-jsoni.php](03-object-with-jsoni.php) | Custom serialization via the `JsonI` interface |
+| [04-object-auto-mapping.php](04-object-auto-mapping.php) | Auto-mapping via public getters and public properties |
+| [05-naming-styles.php](05-naming-styles.php) | `camel` / `snake` / `kebab` / `none` styles + letter case |
+| [06-decode-and-read.php](06-decode-and-read.php) | Decoding JSON strings and reading from files |
+| [07-jsonx.php](07-jsonx.php) | Converting JSON to JSONx (XML) format |
+
+Run any example from the project root:
+
+```bash
+php examples/01-basic-usage.php
+```