chore: Enhance PHP Docs

Author: usernane

WebFiori/Json/CaseConverter.php

@@ -14,21 +14,17 @@
  * A class which is used to convert string case from one to another (e.g. camel to snake).
  *
  * @author Ibrahim
- * 
- * @version 1.0
  */
 class CaseConverter {
     /**
-     * An array of supported property styles.
+     * An array of supported letter cases.
      * 
      * This array holds the following values:
      * <ul>
-     * <li>camel</li>
-     * <li>kebab</li>
-     * <li>snake</li>
-     * <li>none</li>
+     * <li>same</li>
+     * <li>upper</li>
+     * <li>lower</li>
      * </ul>
-     * 
      */
     const LETTER_CASE = [
         'same',
@@ -45,7 +41,6 @@ class CaseConverter {
      * <li>snake</li>
      * <li>none</li>
      * </ul>
-     * 
      */
     const PROP_NAME_STYLES = [
         'camel',
@@ -76,13 +71,11 @@ class CaseConverter {
      * </ul>
      * If the given value is none of the given 3, the string wouldn't be changed.
      * 
-     * 
      * @return string The same string converted to selected style.
-     * 
      */
     public static function convert(string $value, string $style, string $letterCase = 'same') : string {
         if ($style == 'snake') {
-            return self::toSnackCase($value, $letterCase);
+            return self::toSnakeCase($value, $letterCase);
         } else if ($style == 'kebab') {
             return self::toKebabCase($value, $letterCase);
         } else if ($style == 'camel') {
@@ -117,7 +110,6 @@ public static function isUpper(string $char) : bool {
      * 
      * @return string The method will return the string after conversion. For
      * example, if the string is 'my-val', the method will return the string 'myVal'.
-     * 
      */
     public static function toCamelCase(string $value, string $letterCase = 'same') : string {
         $retVal = '';
@@ -158,7 +150,6 @@ public static function toCamelCase(string $value, string $letterCase = 'same') :
      * 
      * @return string The method will return the string after conversion. For
      * example, if the string is 'myVal', the method will return the string 'my-val'.
-     * 
      */
     public static function toKebabCase(string $value, string $letterCase = 'same') : string {
         return self::toSnakeOrKebab($value, $letterCase, '_', '-');
@@ -179,9 +170,8 @@ public static function toKebabCase(string $value, string $letterCase = 'same') :
      * 
      * @return string The method will return the string after conversion. For
      * example, if the string is 'my-val', the method will return the string 'my_val'.
-     * 
      */
-    public static function toSnackCase(string $value, string $letterCase = 'same') : string {
+    public static function toSnakeCase(string $value, string $letterCase = 'same') : string {
         return self::toSnakeOrKebab($value, $letterCase, '-', '_');
     }
     private static function addChar($x, &$isNumFound, $to, $char, &$snakeOrKebabFound, $nextChar) : string {

WebFiori/Json/JsonConverter.php

@@ -14,8 +14,6 @@
  * A class to convert Json instance to it's JSON string representation.
  *
  * @author Ibrahim
- * 
- * @version 1.0
  */
 class JsonConverter {
     private static $CRLF = "\r\n";

WebFiori/Json/JsonI.php

@@ -11,21 +11,18 @@
 namespace WebFiori\Json;
 
 /**
- * An interface for the objects that can be added to an instance of JsonX.
+ * An interface for the objects that can be added to an instance of Json.
  * @author Ibrahim 
- * @version 1.0
- * @see JsonX
+ * @see Json
  */
 interface JsonI {
     /**
-     * Returns an object of type JsonX.
+     * Returns an object of type Json.
      * This method can be implemented by any class that will be added  
-     * to any JsonX instance. It is used to customize the generated 
+     * to any Json instance. It is used to customize the generated 
      * JSON string.
      * 
-     * @return Json An instance of JsonX.
-     * 
-     * @since 1.0
+     * @return Json An instance of Json.
      */
     public function toJSON() : Json;
 }

WebFiori/Json/JsonTypes.php

@@ -14,50 +14,34 @@
  * A class that contains constants which represents supported JSON data types.
  *
  * @author Ibrahim
- * 
- * @version 1.0
  */
 abstract class JsonTypes {
     /**
      * A constant that indicates that given datatype is of type array.
-     * 
-     * @since 1.0
      */
     const ARR = 'array';
     /**
      * A constant that indicates that given datatype is of type boolean.
-     * 
-     * @since 1.0
      */
     const BOOL = 'boolean';
     /**
      * A constant that indicates that given datatype is of type double (or float).
-     * 
-     * @since 1.0
      */
     const DOUBLE = 'double';
     /**
      * A constant that indicates that given datatype is of type integer.
-     * 
-     * @since 1.0
      */
     const INT = 'integer';
     /**
      * A constant that indicates that given datatype is null.
-     * 
-     * @since 1.0
      */
     const NUL = 'NULL';
     /**
      * A constant that indicates that given datatype is an object.
-     * 
-     * @since 1.0
      */
     const OBJ = 'object';
     /**
      * A constant that indicates that given datatype is of type string.
-     * 
-     * @since 1.0
      */
     const STRING = 'string';
 }

WebFiori/Json/Property.php

@@ -18,39 +18,39 @@
  */
 class Property {
     /**
+     * A boolean value that determines if an array will be represented as an object or not.
      * 
      * @var boolean
-     * 
-     * @since 1.0
      */
     private $asObject;
     /**
+     * The datatype of the property value.
      * 
      * @var string
-     * 
-     * @since 1.0
      */
     private $datatype;
-    private $lettersCase;
     /**
+     * The case of the property name (same, upper, or lower).
      * 
      * @var string
+     */
+    private $lettersCase;
+    /**
+     * The name of the property.
      * 
-     * @since 1.0
+     * @var string
      */
     private $name;
     /**
+     * The style of the property name (camel, kebab, snake, or none).
      * 
      * @var string
-     * 
-     * @since 1.0
      */
     private $probsStyle;
     /**
+     * The value of the property.
      * 
      * @var mixed
-     * 
-     * @since 1.0
      */
     private $value;
     /**
@@ -80,8 +80,6 @@ class Property {
      * The default value is 'same'.
      * 
      * @throws InvalidArgumentException If the name of the property is invalid
-     * 
-     * @since 1.0
      */
     public function __construct(string $name, $value, ?string $style = 'none', string $case = 'same') {
         $this->name = '';
@@ -104,8 +102,6 @@ public function __construct(string $name, $value, ?string $style = 'none', strin
      * Returns the value of the property.
      * 
      * @return mixed|Json The value of the property.
-     * 
-     * @since 1.0
      */
     public function &getValue() {
         return $this->value;
@@ -130,8 +126,6 @@ public function getCase() : string {
      * 
      * @return string The returned string will have the following syntax:
      * "json:<type>" where "<type>" is the datatype of the property.
-     * 
-     * @since 1.0
      */
     public function getJsonXTagName() : string {
         $type = $this->getType();
@@ -166,8 +160,6 @@ public function getJsonXTagName() : string {
      * 
      * @return string The name of the property. Note that the returned value
      * will depend on the style at which the property name is set to use.
-     * 
-     * @since 1.0
      */
     public function getName() : string {
         return $this->name;
@@ -183,8 +175,6 @@ public function getName() : string {
      * <li>none</li>
      * </ul>
      * The default value is 'none'.
-     * 
-     * @since 1.0
      */
     public function getStyle() : string {
         return $this->probsStyle;
@@ -201,8 +191,6 @@ public function getStyle() : string {
      * <li>object</li>
      * <li>NULL</li>
      * </ul>
-     * 
-     * @since 1.0
      */
     public function getType() : string {
         return $this->datatype;
@@ -215,8 +203,6 @@ public function getType() : string {
      * 
      * @return bool If the property will be represented as object, true is
      * returned. False otherwise.
-     * 
-     * @since 1.0
      */
     public function isAsObject() : bool {
         return $this->asObject;
@@ -230,8 +216,6 @@ public function isAsObject() : bool {
      * 
      * @param bool $bool True to represent the array as object. False 
      * otherwise.
-     * 
-     * @since 1.0
      */
     public function setAsObject(bool $bool) {
         $this->asObject = $bool;
@@ -243,8 +227,6 @@ public function setAsObject(bool $bool) {
      * 
      * @return bool If the name is set, the method will return true. False
      * otherwise.
-     * 
-     * @since 1.0
      */
     public function setName(string $name) : bool {
         $keyValidity = self::isValidKey($name, $this->getStyle(), $this->getCase());
@@ -274,7 +256,7 @@ public function setName(string $name) : bool {
      * <li>none</li>
      * </ul>
      * 
-     * @since 1.0
+     * @param string $lettersCase The case of the letters in the property name.
      */
     public function setStyle(string $style, string $lettersCase = 'same') {
         $trimmed = strtolower(trim($style));
@@ -296,8 +278,6 @@ public function setStyle(string $style, string $lettersCase = 'same') {
      * 
      * @param mixed $val The value of the property. This can be a string or
      * array or number or an object or null.
-     * 
-     * @since 1.0
      */
     public function setValue($val) {
         $this->datatype = gettype($val);
@@ -317,8 +297,6 @@ public function setValue($val) {
      * 
      * @return bool|string If the key is valid, it will be returned 
      * after trimmed. If not valid, false is returned.
-     * 
-     * @since 1.0
      */
     private static function isValidKey($key, $style = 'kebab', $case = 'same') {
         $trimmedKey = trim($key);