1. <?php
  3. /**
  4. * Extends API payload logic with basic sanity checks.
  5. *
  6. * @param array $payload The API payload data.
  7. * @param array $requiredFields Array of required field names.
  8. * @return array|false The validated payload, or false if validation fails.
  9. */
  10. function validateAndExtendPayload(array $payload, array $requiredFields): array|false
  11. {
  12. // Check if required fields are present
  13. foreach ($requiredFields as $field) {
  14. if (!isset($payload[$field])) {
  15. error_log("Missing required field: " . $field); // Log the error
  16. return false; // Validation failed
  17. }
  18. }
  20. // Sanity checks for data types and values
  21. if (!is_string($payload['name'])) {
  22. error_log("Invalid 'name' field: must be a string.");
  23. return false;
  24. }
  26. if (!is_numeric($payload['amount']) || $payload['amount'] <= 0) {
  27. error_log("Invalid 'amount' field: must be a positive number.");
  28. return false;
  29. }
  31. if (!is_array($payload['tags'])) {
  32. error_log("Invalid 'tags' field: must be an array.");
  33. return false;
  34. }
  36. //Extend the payload with default values or calculated values
  37. $payload['timestamp'] = time(); // Add timestamp
  38. $payload['status'] = 'pending'; //Add status
  40. return $payload; // Validation successful
  41. }
  43. //Example Usage:
  44. /*
  45. $legacyPayload = [
  46. 'name' => 'Product X',
  47. 'amount' => 100,
  48. 'tags' => ['category1', 'category2']
  49. ];
  51. $requiredFields = ['name', 'amount'];
  53. $validatedPayload = validateAndExtendPayload($legacyPayload, $requiredFields);
  55. if ($validatedPayload !== false) {
  56. print_r($validatedPayload);
  57. } else {
  58. echo "Payload validation failed.\n";
  59. }
  60. */
  62. ?>

Add your comment