feat: Added Support for Converting Public Props

Author: usernane

WebFiori/Json/Json.php

@@ -358,26 +358,29 @@ public function addNumber(string $key, $value) {
         return true;
     }
     /**
-     * Adds an object to the JSON string.
-     * 
-     * The object that will be added can implement the interface JsonI to make 
-     * the generated JSON string customizable. Also, the object can be of 
-     * type Json. If the given value is an object that does not implement the 
-     * interface JsonI, or it is not of type Json,
-     * The method will try to extract object information based on its "getXxxxx()" public 
-     * methods. Assuming that the object has 2 public methods with names 
-     * <code>getFirstProp()</code> and <code>getSecondProp()</code>. 
-     * In that case, the generated JSON will be on the format
-     * <b>{"FirstProp":"prop-1","SecondProp":""}</b>.
-     * This method also can be used to update the value of an existing property.
-     * 
+     * Adds an object to the JSON data.
+     *
+     * The object is serialized using the following rules:
+     * <ul>
+     * <li>If the object implements {@see JsonI}, its {@see JsonI::toJSON()} method
+     * is called to produce the JSON representation.</li>
+     * <li>If the object is already an instance of {@see Json}, it is used directly.</li>
+     * <li>Otherwise, all public getter methods (prefixed with 'get') are called and
+     * mapped to properties. The property name is the method name with the 'get' prefix
+     * removed (e.g. <code>getFirstProp()</code> becomes <code>FirstProp</code>).
+     * Methods returning false or null are skipped.</li>
+     * <li>Additionally, all public properties of the object are extracted via reflection
+     * and added to the JSON output. Public properties with a null value are included;
+     * private and protected properties are ignored.</li>
+     * </ul>
+     * This method can also be used to update the value of an existing property.
+     *
      * @param string $key The key value.
-     * 
+     *
      * @param JsonI|Json|object $val The object that will be added.
-     * 
-     * @return bool The method will return true if the object is added. 
-     * If the key value is invalid string, the method will return false.
-     * 
+     *
+     * @return bool True if the object is added, false if the key is invalid.
+     *
      */
     public function addObject(string $key, &$val) {
         if (!$this->updateExisting($key, $val)) {

WebFiori/Json/JsonConverter.php

@@ -11,10 +11,22 @@
 namespace WebFiori\Json;
 
 /**
- * A class to convert Json instance to it's JSON string representation.
+ * A class to convert objects and Json instances to their JSON string representation.
+ *
+ * The conversion of plain objects follows this order of precedence:
+ * <ol>
+ * <li>If the object implements {@see JsonI}, its {@see JsonI::toJSON()} method is called.</li>
+ * <li>If the object is already an instance of {@see Json}, it is returned as-is.</li>
+ * <li>Otherwise, public getter methods (prefixed with 'get') are called and their return
+ * values are mapped to properties. The property name is derived by stripping the 'get'
+ * prefix (e.g. <code>getFullName()</code> becomes <code>FullName</code>). Methods that
+ * return false or null are skipped.</li>
+ * <li>Finally, all public properties are extracted via reflection and added to the JSON
+ * output. Unlike getter-based mapping, public properties with a null value are included.</li>
+ * </ol>
  *
  * @author Ibrahim
- * 
+ *
  */
 class JsonConverter {
     private static $CRLF = "\r\n";
@@ -23,25 +35,31 @@ class JsonConverter {
     private static $TabSize = 0;
     private static $XmlClosingPool = [];
     /**
-     * Convert an object to Json object.
-     * 
-     * Note that the properties which will be in the generated Json
-     * object will depend on the public 'get' methods of the object.
-     * The name of the properties will depend on the name of the method. For
-     * example, if the name of one of the methods is 'getFullName', then
-     * property name will be 'FullName'.
-     * 
-     * @param object $obj The object that will be converted.
-     * 
-     * @return Json
+     * Converts a plain PHP object to a {@see Json} instance.
+     *
+     * The conversion follows this order:
+     * <ol>
+     * <li>If the object implements {@see JsonI}, its {@see JsonI::toJSON()} method is
+     * called and the result is returned directly.</li>
+     * <li>If the object is already an instance of {@see Json}, it is returned as-is.</li>
+     * <li>All public methods whose names start with 'get' are called. The portion of the
+     * method name after 'get' becomes the property name (e.g. <code>getFullName()</code>
+     * produces the key <code>FullName</code>). Methods returning false or null are
+     * skipped.</li>
+     * <li>All public properties are extracted via {@see \ReflectionClass} and added to
+     * the result. Properties with a null value are included; private and protected
+     * properties are ignored.</li>
+     * </ol>
+     *
+     * @param object $obj The object to convert.
+     *
+     * @return Json A Json instance populated with the object's data.
      */
     public static function objectToJson($obj) {
         if (is_subclass_of($obj, 'Webfiori\\Json\\JsonI')) {
             return $obj->toJSON();
-        } else {
-            if ($obj instanceof Json) {
-                return $obj;
-            }
+        } else if ($obj instanceof Json) {
+            return $obj;
         }
 
         $methods = get_class_methods($obj);
@@ -61,8 +79,18 @@ public static function objectToJson($obj) {
                 }
             }
         }
+
         restore_error_handler();
 
+        $reflection = new \ReflectionClass($obj);
+        $publicProps = $reflection->getProperties(\ReflectionProperty::IS_PUBLIC);
+        
+        foreach ($publicProps as $prop) {
+            $name = $prop->getName();
+            $value = $prop->getValue($obj);
+            $json->add($name, $value);
+        }
+
         return $json;
     }
     /**
@@ -330,13 +358,18 @@ private static function getNumberVal($val) {
         return $retVal;
     }
     /**
-     * 
-     * @param object $probVal
-     * 
-     * @param string $style
-     * 
-     * @return string
-     * 
+     * Converts an object value to its JSON string representation.
+     *
+     * If the value is not already a {@see Json} instance and does not implement
+     * {@see JsonI}, it is first passed through {@see self::objectToJson()} which
+     * maps public getter methods and public properties via reflection.
+     *
+     * @param object $probVal The object to convert.
+     * @param string $style   The property naming style to apply.
+     * @param string $lettersCase The letter case to apply to property names.
+     *
+     * @return string JSON object string representation.
+     *
      * @since 1.0
      */
     private static function objToJson($probVal, string $style, string $lettersCase) {

WebFiori/Json/JsonI.php

@@ -11,18 +11,28 @@
 namespace WebFiori\Json;
 
 /**
- * An interface for the objects that can be added to an instance of Json.
- * @author Ibrahim 
+ * Interface for objects that provide a custom JSON representation.
+ *
+ * Implementing this interface allows a class to control exactly how it is
+ * serialized when passed to {@see Json::addObject()} or
+ * {@see JsonConverter::objectToJson()}. When either of those methods encounters
+ * an object that implements this interface, they call {@see JsonI::toJSON()}
+ * instead of falling back to getter-method or reflection-based mapping.
+ *
+ * @author Ibrahim
  * @see Json
+ * @see JsonConverter
  */
 interface JsonI {
     /**
-     * Returns an object of type Json.
-     * This method can be implemented by any class that will be added  
-     * to any Json instance. It is used to customize the generated 
-     * JSON string.
-     * 
-     * @return Json An instance of Json.
+     * Returns a {@see Json} instance that represents the object.
+     *
+     * Implement this method to define which properties are included in the
+     * JSON output and how they are named. The returned instance will be used
+     * directly by {@see Json::addObject()} and {@see JsonConverter::objectToJson()},
+     * bypassing getter-method scanning and reflection-based property extraction.
+     *
+     * @return Json A Json instance representing this object.
      */
     public function toJSON() : Json;
 }

tests/WebFiori/Tests/Json/JsonConverterTest.php

@@ -5,6 +5,7 @@
 use WebFiori\Json\Json;
 use WebFiori\Tests\Obj0;
 use WebFiori\Tests\Obj1;
+use WebFiori\Tests\ObjWithPublicProps;
 use PHPUnit\Framework\TestCase;
 use WebFiori\Json\Property;
 use WebFiori\Json\JsonConverter;
@@ -76,4 +77,44 @@ public function testPropertyToJsonXString01() {
                 . '    world'."\r\n"
                 . '</json:string>'."\r\n", JsonConverter::propertyToJsonXString($prop, false));
     }
+
+    /**
+     * @test
+     */
+    public function testObjectToJsonPublicPropsBasic() {
+        $obj = new \WebFiori\Tests\ObjWithPublicProps('Ibrahim', 30, true);
+        $json = JsonConverter::objectToJson($obj);
+        $this->assertTrue($json instanceof Json);
+        $this->assertTrue($json->hasKey('name'));
+        $this->assertTrue($json->hasKey('age'));
+        $this->assertTrue($json->hasKey('active'));
+    }
+    /**
+     * @test
+     */
+    public function testObjectToJsonPublicPropsValues() {
+        $obj = new \WebFiori\Tests\ObjWithPublicProps('Ibrahim', 30, true);
+        $json = JsonConverter::objectToJson($obj);
+        $this->assertEquals('Ibrahim', $json->get('name'));
+        $this->assertEquals(30, $json->get('age'));
+        $this->assertEquals(true, $json->get('active'));
+    }
+    /**
+     * @test
+     */
+    public function testObjectToJsonPrivatePropsNotIncluded() {
+        $obj = new \WebFiori\Tests\ObjWithPublicProps('Ibrahim', 30, true);
+        $json = JsonConverter::objectToJson($obj);
+        $this->assertFalse($json->hasKey('secret'));
+    }
+    /**
+     * @test
+     */
+    public function testObjectToJsonPublicPropsNullValue() {
+        $obj = new \WebFiori\Tests\ObjWithPublicProps('Ibrahim', 30, true);
+        $obj->name = null;
+        $json = JsonConverter::objectToJson($obj);
+        $this->assertTrue($json->hasKey('name'));
+        $this->assertNull($json->get('name'));
+    }
 }

tests/WebFiori/Tests/ObjWithPublicProps.php

@@ -0,0 +1,15 @@
+<?php
+namespace WebFiori\Tests;
+
+class ObjWithPublicProps {
+    public $name;
+    public $age;
+    public $active;
+    private $secret = 'hidden';
+
+    public function __construct($name, $age, $active) {
+        $this->name = $name;
+        $this->age = $age;
+        $this->active = $active;
+    }
+}