1. <?php
  3. /**
  4. * Attaches metadata to user input with defensive checks.
  5. *
  6. * @param array $data The input data array.
  7. * @param string $metadata_key The key to store the metadata under.
  8. * @param array $metadata The metadata array to attach.
  9. * @return array The modified data array with metadata attached. Returns original data if input is invalid.
  10. */
  11. function attachMetadata(array $data, string $metadata_key, array $metadata): array
  12. {
  13. // Defensive check: Ensure input data is an array
  14. if (!is_array($data)) {
  15. error_log("attachMetadata: Input data is not an array.");
  16. return $data; // Return original data if invalid
  17. }
  19. // Defensive check: Ensure metadata_key is a string
  20. if (!is_string($metadata_key)) {
  21. error_log("attachMetadata: metadata_key is not a string.");
  22. return $data; // Return original data if invalid
  23. }
  25. // Defensive check: Ensure metadata is an array
  26. if (!is_array($metadata)) {
  27. error_log("attachMetadata: metadata is not an array.");
  28. return $data; // Return original data if invalid
  29. }
  31. // Defensive check: Prevent overwriting existing metadata
  32. if (isset($data[$metadata_key])) {
  33. error_log("attachMetadata: Metadata key already exists. Skipping attachment.");
  34. return $data; // Skip if key already exists
  35. }
  37. // Attach metadata
  38. $data[$metadata_key] = $metadata;
  40. return $data;
  41. }
  43. //Example usage (for testing - remove before production)
  44. /*
  45. $input_data = ['name' => 'John Doe', 'email' => 'john.doe@example.com'];
  46. $metadata = ['created_at' => date('Y-m-d H:i:s'), 'user_id' => 123];
  48. $modified_data = attachMetadata($input_data, 'user_metadata', $metadata);
  50. print_r($modified_data);
  51. */
  53. ?>

Add your comment