1. <?php
  3. /**
  4. * Extends API payload validation with memory efficiency.
  5. *
  6. * This function iterates through the payload data, performing validation
  7. * checks on individual elements without loading the entire payload into memory.
  8. * Suitable for large JSON responses.
  9. *
  10. * @param string $json_string The JSON string to validate.
  11. * @param array $validation_rules An array of validation rules. Each rule should be an associative array with keys: 'field', 'type', 'validate_function', 'message'.
  12. * @return array|false An array of validation errors if any, or false on failure to decode JSON.
  13. */
  14. function validateApiPayload(string $json_string, array $validation_rules): array|false
  15. {
  16. $errors = [];
  18. $data = json_decode($json_string, true);
  20. if ($data === null) {
  21. return false; // JSON decode failed
  22. }
  24. foreach ($validation_rules as $rule) {
  25. $field = $rule['field'];
  26. $type = $rule['type'];
  27. $validate_function = $rule['validate_function'];
  28. $message = $rule['message'];
  30. // Check if the field exists in the data
  31. if (!isset($data[$field])) {
  32. $errors[] = ['field' => $field, 'message' => $message];
  33. continue;
  34. }
  36. // Validate the field based on the specified type
  37. $validation_result = call_user_func($validate_function, $data[$field]);
  39. if ($validation_result === false) {
  40. $errors[] = ['field' => $field, 'message' => $validation_result];
  41. }
  42. }
  44. return $errors;
  45. }
  47. /**
  48. * Example validation functions. Can be extended as needed.
  49. *
  50. * @param mixed $value The value to validate.
  51. * @return bool|string Returns true on success, or an error message on failure.
  52. */
  53. function validateString(string $value)
  54. {
  55. return !empty($value);
  56. }
  58. function validateInt(int $value)
  59. {
  60. return is_int($value);
  61. }
  63. function validateEmail(string $value)
  64. {
  65. return filter_var($value, FILTER_VALIDATE_EMAIL) !== false;
  66. }
  68. function validateArray(array $value) {
  69. return is_array($value);
  70. }
  73. // Example Usage:
  74. /*
  75. $json = '[
  76. {"name": "John Doe", "email": "john.doe@example.com", "age": 30},
  77. {"name": "Jane Smith", "email": "invalid-email", "age": "abc"}
  78. ]';
  80. $rules = [
  81. ['field' => 'name', 'type' => 'validateString', 'validate_function' => 'validateString', 'message' => 'Name cannot be empty.'],
  82. ['field' => 'email', 'type' => 'validateEmail', 'validate_function' => 'validateEmail', 'message' => 'Invalid email address.'],
  83. ['field' => 'age', 'type' => 'validateInt', 'validate_function' => 'validateInt', 'message' => 'Age must be an integer.'],
  84. ['field' => 'age', 'type' => 'validateInt', 'validate_function' => 'validateInt', 'message' => 'Age must be an integer.'],
  85. ['field' => 'address', 'type' => 'validateArray', 'validate_function' => 'validateArray', 'message' => 'Address must be an array.'],
  86. ];
  88. $errors = validateApiPayload($json, $rules);
  90. if (empty($errors)) {
  91. echo "Payload is valid.\n";
  92. } else {
  93. echo "Validation errors:\n";
  94. foreach ($errors as $error) {
  95. echo " Field: " . $error['field'] . ", Message: " . $error['message'] . "\n";
  96. }
  97. }
  98. */
  100. ?>

Add your comment