1. <?php
  3. /**
  4. * Validates JSON payloads for staging environments with defensive checks.
  5. *
  6. * @param string $jsonString The JSON string to validate.
  7. * @param array $requiredFields An array of required field names.
  8. * @return array|false An associative array of validation errors, or false on fatal error.
  9. */
  10. function validateJsonPayload(string $jsonString, array $requiredFields): array|false
  11. {
  12. $errors = [];
  14. // Decode the JSON string
  15. $data = json_decode($jsonString, true);
  17. // Check for JSON decoding errors
  18. if (json_last_error() !== JSON_ERROR_NONE) {
  19. $errors['json_error'] = json_last_error_msg();
  20. return $errors;
  21. }
  23. // Defensive check: Ensure decoded data is an array
  24. if (!is_array($data)) {
  25. $errors['type_error'] = 'Expected JSON object (array).';
  26. return $errors;
  27. }
  29. // Validate required fields
  30. foreach ($requiredFields as $field) {
  31. if (!isset($data[$field])) {
  32. $errors[$field] = "Field '$field' is required.";
  33. }
  34. }
  36. // Defensive check: Ensure data types are valid (example: string, integer, boolean)
  37. foreach ($requiredFields as $field) {
  38. if (isset($data[$field])) {
  39. $expectedType = 'string'; // Default type. Can be configured.
  40. if (array_key_exists($field, $_ENV) && $_ENV[$field] === 'integer') {
  41. $expectedType = 'integer';
  42. }
  43. if (array_key_exists($field, $_ENV) && $_ENV[$field] === 'boolean') {
  44. $expectedType = 'boolean';
  45. }
  47. if (!is_string($data[$field]) && $expectedType === 'string') {
  48. $errors[$field] = "Field '$field' must be a string.";
  49. } elseif (!is_int($data[$field]) && $expectedType === 'integer') {
  50. $errors[$field] = "Field '$field' must be an integer.";
  51. } elseif (!is_bool($data[$field]) && $expectedType === 'boolean') {
  52. $errors[$field] = "Field '$field' must be a boolean.";
  53. }
  54. }
  55. }
  57. return $errors;
  58. }
  61. //Example Usage (for testing):
  62. /*
  63. $json = '{
  64. "name": "John Doe",
  65. "age": 30,
  66. "city": "New York"
  67. }';
  69. $required = ['name', 'age'];
  70. $validationErrors = validateJsonPayload($json, $required);
  72. if (empty($validationErrors)) {
  73. echo "JSON payload is valid.\n";
  74. } else {
  75. echo "JSON payload is invalid:\n";
  76. foreach ($validationErrors as $error) {
  77. echo $error . "\n";
  78. }
  79. }
  80. */
  82. ?>

Add your comment