From 425595f5c017951dbc7fd12e878689c5ca5c3ded Mon Sep 17 00:00:00 2001
From: mahdahar <89adham@gmail.com>
Date: Wed, 18 Feb 2026 10:15:47 +0700
Subject: [PATCH] feat: Implement custom ResponseTrait with automatic empty
 string to null conversion

- Create App\Traits\ResponseTrait that wraps CodeIgniter\API\ResponseTrait
- Add json_helper with convert_empty_strings_to_null() and prepare_json_response() functions
- Replace all imports of CodeIgniter\API\ResponseTrait with App\Traits\ResponseTrait across all controllers
- Add 'json' helper to BaseController helpers array
- Ensure consistent API response formatting across the application
---
 app/Controllers/AreaGeoController.php         |  2 +-
 app/Controllers/AuthController.php            |  2 +-
 app/Controllers/AuthV2Controller.php          |  2 +-
 app/Controllers/BaseController.php            |  4 +-
 app/Controllers/Contact/ContactController.php |  2 +-
 .../Contact/MedicalSpecialtyController.php    |  2 +-
 .../Contact/OccupationController.php          |  2 +-
 app/Controllers/CounterController.php         |  2 +-
 app/Controllers/DashboardController.php       |  2 +-
 app/Controllers/EdgeController.php            |  2 +-
 app/Controllers/HomeController.php            |  2 +-
 app/Controllers/LocationController.php        |  2 +-
 app/Controllers/OrderTestController.php       |  2 +-
 .../Organization/AccountController.php        |  2 +-
 .../Organization/DepartmentController.php     |  2 +-
 .../Organization/DisciplineController.php     |  2 +-
 .../Organization/SiteController.php           |  2 +-
 .../Organization/WorkstationController.php    |  2 +-
 app/Controllers/PatVisitController.php        |  2 +-
 app/Controllers/Patient/PatientController.php |  2 +-
 .../Result/ResultValueSetController.php       |  2 +-
 app/Controllers/ResultController.php          |  2 +-
 app/Controllers/SampleController.php          |  2 +-
 .../Specimen/ContainerDefController.php       |  2 +-
 .../Specimen/SpecimenCollectionController.php |  2 +-
 .../Specimen/SpecimenController.php           |  2 +-
 .../Specimen/SpecimenPrepController.php       |  2 +-
 .../Specimen/SpecimenStatusController.php     |  2 +-
 app/Controllers/Test/DemoOrderController.php  |  2 +-
 app/Controllers/Test/TestMapController.php    |  2 +-
 app/Controllers/TestsController.php           |  2 +-
 app/Controllers/ValueSetController.php        |  2 +-
 app/Controllers/ValueSetDefController.php     |  2 +-
 app/Controllers/ZonesController.php           |  2 +-
 app/Helpers/json_helper.php                   | 47 +++++++++++++++++++
 app/Traits/ResponseTrait.php                  | 31 ++++++++++++
 36 files changed, 113 insertions(+), 35 deletions(-)
 create mode 100644 app/Helpers/json_helper.php
 create mode 100644 app/Traits/ResponseTrait.php

diff --git a/app/Controllers/AreaGeoController.php b/app/Controllers/AreaGeoController.php
index 009311c..b316c9f 100644
--- a/app/Controllers/AreaGeoController.php
+++ b/app/Controllers/AreaGeoController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\AreaGeoModel;
 
diff --git a/app/Controllers/AuthController.php b/app/Controllers/AuthController.php
index 389881f..5063000 100644
--- a/app/Controllers/AuthController.php
+++ b/app/Controllers/AuthController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 use Firebase\JWT\JWT;
diff --git a/app/Controllers/AuthV2Controller.php b/app/Controllers/AuthV2Controller.php
index c84303b..f88efb3 100644
--- a/app/Controllers/AuthV2Controller.php
+++ b/app/Controllers/AuthV2Controller.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 use Firebase\JWT\JWT;
diff --git a/app/Controllers/BaseController.php b/app/Controllers/BaseController.php
index 689405b..9006ad7 100644
--- a/app/Controllers/BaseController.php
+++ b/app/Controllers/BaseController.php
@@ -30,12 +30,12 @@ abstract class BaseController extends Controller
 
     /**
      * An array of helpers to be loaded automatically upon
-     * class instantiation. These helpers will be available
+     * class instantiation. These will be available
      * to all other controllers that extend BaseController.
      *
      * @var list<string>
      */
-    protected $helpers = [];
+    protected $helpers = ['json'];
 
     /**
      * Be sure to declare properties for any property fetch you initialized.
diff --git a/app/Controllers/Contact/ContactController.php b/app/Controllers/Contact/ContactController.php
index 22bcfcf..f3286c6 100644
--- a/app/Controllers/Contact/ContactController.php
+++ b/app/Controllers/Contact/ContactController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Contact;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 use App\Models\Contact\ContactModel;
diff --git a/app/Controllers/Contact/MedicalSpecialtyController.php b/app/Controllers/Contact/MedicalSpecialtyController.php
index 8e3e9ae..1476705 100644
--- a/app/Controllers/Contact/MedicalSpecialtyController.php
+++ b/app/Controllers/Contact/MedicalSpecialtyController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Contact;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\Contact\MedicalSpecialtyModel;
 
diff --git a/app/Controllers/Contact/OccupationController.php b/app/Controllers/Contact/OccupationController.php
index 43d017a..1bc29d6 100644
--- a/app/Controllers/Contact/OccupationController.php
+++ b/app/Controllers/Contact/OccupationController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Contact;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\Contact\OccupationModel;
 
diff --git a/app/Controllers/CounterController.php b/app/Controllers/CounterController.php
index 31e2039..7e61df9 100644
--- a/app/Controllers/CounterController.php
+++ b/app/Controllers/CounterController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\CounterModel;
 
diff --git a/app/Controllers/DashboardController.php b/app/Controllers/DashboardController.php
index c6b69b7..cb28273 100644
--- a/app/Controllers/DashboardController.php
+++ b/app/Controllers/DashboardController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 use Firebase\JWT\JWT;
diff --git a/app/Controllers/EdgeController.php b/app/Controllers/EdgeController.php
index b256669..045ab28 100644
--- a/app/Controllers/EdgeController.php
+++ b/app/Controllers/EdgeController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 class EdgeController extends Controller
diff --git a/app/Controllers/HomeController.php b/app/Controllers/HomeController.php
index e76ca6a..d3e3de0 100644
--- a/app/Controllers/HomeController.php
+++ b/app/Controllers/HomeController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 use Firebase\JWT\JWT;
diff --git a/app/Controllers/LocationController.php b/app/Controllers/LocationController.php
index fae89c0..f695689 100644
--- a/app/Controllers/LocationController.php
+++ b/app/Controllers/LocationController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\Location\LocationModel;
 
diff --git a/app/Controllers/OrderTestController.php b/app/Controllers/OrderTestController.php
index 4be3173..1511aa0 100644
--- a/app/Controllers/OrderTestController.php
+++ b/app/Controllers/OrderTestController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 use App\Libraries\ValueSet;
 use App\Models\OrderTestModel;
diff --git a/app/Controllers/Organization/AccountController.php b/app/Controllers/Organization/AccountController.php
index 0cc7ec6..a2b755f 100644
--- a/app/Controllers/Organization/AccountController.php
+++ b/app/Controllers/Organization/AccountController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Organization;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 
 use App\Models\Organization\AccountModel;
diff --git a/app/Controllers/Organization/DepartmentController.php b/app/Controllers/Organization/DepartmentController.php
index db76c50..8e3e416 100644
--- a/app/Controllers/Organization/DepartmentController.php
+++ b/app/Controllers/Organization/DepartmentController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Organization;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 
 use App\Models\Organization\DepartmentModel;
diff --git a/app/Controllers/Organization/DisciplineController.php b/app/Controllers/Organization/DisciplineController.php
index c36d9a5..2d91354 100644
--- a/app/Controllers/Organization/DisciplineController.php
+++ b/app/Controllers/Organization/DisciplineController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Organization;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 
 use App\Models\Organization\DisciplineModel;
diff --git a/app/Controllers/Organization/SiteController.php b/app/Controllers/Organization/SiteController.php
index 9c0c2d6..6010689 100644
--- a/app/Controllers/Organization/SiteController.php
+++ b/app/Controllers/Organization/SiteController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Organization;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 
 use App\Models\Organization\SiteModel;
diff --git a/app/Controllers/Organization/WorkstationController.php b/app/Controllers/Organization/WorkstationController.php
index 2414783..51d6a7e 100644
--- a/app/Controllers/Organization/WorkstationController.php
+++ b/app/Controllers/Organization/WorkstationController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Organization;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 
 use App\Models\Organization\WorkstationModel;
diff --git a/app/Controllers/PatVisitController.php b/app/Controllers/PatVisitController.php
index abc3149..180d7d1 100644
--- a/app/Controllers/PatVisitController.php
+++ b/app/Controllers/PatVisitController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\PatVisit\PatVisitModel;
 use App\Models\PatVisit\PatVisitADTModel;
diff --git a/app/Controllers/Patient/PatientController.php b/app/Controllers/Patient/PatientController.php
index 23564ac..aad5efe 100644
--- a/app/Controllers/Patient/PatientController.php
+++ b/app/Controllers/Patient/PatientController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Patient;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 use App\Libraries\ValueSet;
 use App\Models\Patient\PatientModel;
diff --git a/app/Controllers/Result/ResultValueSetController.php b/app/Controllers/Result/ResultValueSetController.php
index 21555f0..15ba898 100644
--- a/app/Controllers/Result/ResultValueSetController.php
+++ b/app/Controllers/Result/ResultValueSetController.php
@@ -3,7 +3,7 @@
 namespace App\Controllers\Result;
 
 use App\Models\ValueSet\ValueSetModel;
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 
 class ResultValueSetController extends \CodeIgniter\Controller
 {
diff --git a/app/Controllers/ResultController.php b/app/Controllers/ResultController.php
index f6ee148..f54ee2d 100644
--- a/app/Controllers/ResultController.php
+++ b/app/Controllers/ResultController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 use Firebase\JWT\JWT;
diff --git a/app/Controllers/SampleController.php b/app/Controllers/SampleController.php
index c02e318..bfa850c 100644
--- a/app/Controllers/SampleController.php
+++ b/app/Controllers/SampleController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 
 use Firebase\JWT\JWT;
diff --git a/app/Controllers/Specimen/ContainerDefController.php b/app/Controllers/Specimen/ContainerDefController.php
index 4f9d79c..239be9d 100644
--- a/app/Controllers/Specimen/ContainerDefController.php
+++ b/app/Controllers/Specimen/ContainerDefController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers\Specimen;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 use App\Models\Specimen\ContainerDefModel;
diff --git a/app/Controllers/Specimen/SpecimenCollectionController.php b/app/Controllers/Specimen/SpecimenCollectionController.php
index b799e62..3bd877c 100644
--- a/app/Controllers/Specimen/SpecimenCollectionController.php
+++ b/app/Controllers/Specimen/SpecimenCollectionController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers\Specimen;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 use App\Models\Specimen\SpecimenCollectionModel;
diff --git a/app/Controllers/Specimen/SpecimenController.php b/app/Controllers/Specimen/SpecimenController.php
index 89ec6f9..a23d94c 100644
--- a/app/Controllers/Specimen/SpecimenController.php
+++ b/app/Controllers/Specimen/SpecimenController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers\Specimen;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 use App\Models\Specimen\SpecimenModel;
diff --git a/app/Controllers/Specimen/SpecimenPrepController.php b/app/Controllers/Specimen/SpecimenPrepController.php
index 2238fe9..8fe3d0f 100644
--- a/app/Controllers/Specimen/SpecimenPrepController.php
+++ b/app/Controllers/Specimen/SpecimenPrepController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers\Specimen;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\Specimen\SpecimenPrepModel;
 
diff --git a/app/Controllers/Specimen/SpecimenStatusController.php b/app/Controllers/Specimen/SpecimenStatusController.php
index 46ddbe3..217e5d2 100644
--- a/app/Controllers/Specimen/SpecimenStatusController.php
+++ b/app/Controllers/Specimen/SpecimenStatusController.php
@@ -2,7 +2,7 @@
 
 namespace App\Controllers\Specimen;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 use App\Models\Specimen\SpecimenStatusModel;
diff --git a/app/Controllers/Test/DemoOrderController.php b/app/Controllers/Test/DemoOrderController.php
index 23663fe..a547f64 100644
--- a/app/Controllers/Test/DemoOrderController.php
+++ b/app/Controllers/Test/DemoOrderController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Test;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use CodeIgniter\Controller;
 use App\Libraries\ValueSet;
 use App\Models\Patient\PatientModel;
diff --git a/app/Controllers/Test/TestMapController.php b/app/Controllers/Test/TestMapController.php
index 46522a2..dce946c 100644
--- a/app/Controllers/Test/TestMapController.php
+++ b/app/Controllers/Test/TestMapController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers\Test;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 use App\Models\Test\TestMapModel;
diff --git a/app/Controllers/TestsController.php b/app/Controllers/TestsController.php
index 280dada..4ae56d6 100644
--- a/app/Controllers/TestsController.php
+++ b/app/Controllers/TestsController.php
@@ -1,7 +1,7 @@
 <?php
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Libraries\ValueSet;
 
diff --git a/app/Controllers/ValueSetController.php b/app/Controllers/ValueSetController.php
index 972476d..11ebb9b 100644
--- a/app/Controllers/ValueSetController.php
+++ b/app/Controllers/ValueSetController.php
@@ -4,7 +4,7 @@ namespace App\Controllers;
 
 use App\Libraries\ValueSet;
 use App\Models\ValueSet\ValueSetModel;
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 
 class ValueSetController extends \CodeIgniter\Controller
 {
diff --git a/app/Controllers/ValueSetDefController.php b/app/Controllers/ValueSetDefController.php
index 15dc454..5e574b3 100644
--- a/app/Controllers/ValueSetDefController.php
+++ b/app/Controllers/ValueSetDefController.php
@@ -3,7 +3,7 @@
 namespace App\Controllers;
 
 use App\Models\ValueSet\ValueSetDefModel;
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 
 class ValueSetDefController extends \CodeIgniter\Controller
 {
diff --git a/app/Controllers/ZonesController.php b/app/Controllers/ZonesController.php
index 86db321..9847d76 100644
--- a/app/Controllers/ZonesController.php
+++ b/app/Controllers/ZonesController.php
@@ -2,7 +2,7 @@
 /*
 namespace App\Controllers;
 
-use CodeIgniter\API\ResponseTrait;
+use App\Traits\ResponseTrait;
 use App\Controllers\BaseController;
 use App\Models\SyncCRM\ZonesModel;
 
diff --git a/app/Helpers/json_helper.php b/app/Helpers/json_helper.php
new file mode 100644
index 0000000..4b75dae
--- /dev/null
+++ b/app/Helpers/json_helper.php
@@ -0,0 +1,47 @@
+<?php
+
+if (!function_exists('convert_empty_strings_to_null')) {
+  /**
+   * Recursively convert empty strings to null in arrays or objects
+   * 
+   * @param mixed $data The data to process (array, object, or scalar)
+   * @return mixed The processed data with empty strings converted to null
+   */
+  function convert_empty_strings_to_null($data) {
+    if (is_array($data)) {
+      foreach ($data as $key => $value) {
+        if (is_array($value)) {
+          $data[$key] = convert_empty_strings_to_null($value);
+        } elseif (is_object($value)) {
+          $data[$key] = convert_empty_strings_to_null($value);
+        } elseif ($value === '') {
+          $data[$key] = null;
+        }
+      }
+    } elseif (is_object($data)) {
+      foreach ($data as $key => $value) {
+        if (is_array($value)) {
+          $data->$key = convert_empty_strings_to_null($value);
+        } elseif (is_object($value)) {
+          $data->$key = convert_empty_strings_to_null($value);
+        } elseif ($value === '') {
+          $data->$key = null;
+        }
+      }
+    }
+    return $data;
+  }
+}
+
+if (!function_exists('prepare_json_response')) {
+  /**
+   * Prepare data for JSON response by converting empty strings to null
+   * This is a convenience wrapper around convert_empty_strings_to_null
+   * 
+   * @param mixed $data The data to prepare for JSON response
+   * @return mixed The processed data ready for JSON encoding
+   */
+  function prepare_json_response($data) {
+    return convert_empty_strings_to_null($data);
+  }
+}
diff --git a/app/Traits/ResponseTrait.php b/app/Traits/ResponseTrait.php
new file mode 100644
index 0000000..ecfe63f
--- /dev/null
+++ b/app/Traits/ResponseTrait.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Traits;
+
+use CodeIgniter\API\ResponseTrait as BaseResponseTrait;
+use CodeIgniter\HTTP\ResponseInterface;
+
+trait ResponseTrait
+{
+    use BaseResponseTrait {
+        respond as baseRespond;
+    }
+
+    /**
+     * Send a response with automatic conversion of empty strings to null
+     * 
+     * @param mixed $data
+     * @param int $status
+     * @param string $message
+     * @return ResponseInterface
+     */
+    public function respond($data = null, int $status = 200, string $message = '')
+    {
+        // Convert empty strings to null in the data
+        if ($data !== null && (is_array($data) || is_object($data))) {
+            $data = convert_empty_strings_to_null($data);
+        }
+        
+        return $this->baseRespond($data, $status, $message);
+    }
+}