1. <?php
  3. /**
  4. * Adds metadata to user input for internal tooling.
  5. *
  6. * This function attaches metadata to user input data. It supports
  7. * older PHP versions by using `$_POST` and `$_GET` arrays.
  8. *
  9. * @param array $data The data to add metadata to. Can be $_POST, $_GET, or a custom array.
  10. * @param array $metadata An associative array of metadata key-value pairs.
  11. * @return array The modified data with metadata added. Returns the original data if $data is not an array.
  12. */
  13. function addMetadataToData(array $data, array $metadata): array
  14. {
  15. if (!is_array($data)) {
  16. return $data; // Return original data if not an array
  17. }
  19. // Merge metadata into the data array.
  20. $data = array_merge($data, $metadata);
  22. return $data;
  23. }
  25. /**
  26. * Example usage with $_POST data.
  27. */
  28. if (isset($_POST)) {
  29. $postData = $_POST;
  30. $internalMetadata = [
  31. 'submission_timestamp' => time(),
  32. 'user_agent' => $_SERVER['HTTP_USER_AGENT'],
  33. 'request_ip' => $_SERVER['REMOTE_ADDR'],
  34. 'request_method' => $_SERVER['REQUEST_METHOD']
  35. ];
  37. $metadataWithPost = addMetadataToData($postData, $internalMetadata);
  39. // Now $metadataWithPost contains the original POST data plus the metadata.
  40. // You can then process $metadataWithPost for your internal tooling.
  41. // For example:
  42. // error_log(print_r($metadataWithPost, true)); //Log the data to a file.
  44. //Example of how to access a metadata value
  45. if(isset($metadataWithPost['submission_timestamp'])) {
  46. $timestamp = $metadataWithPost['submission_timestamp'];
  47. error_log("Submission Timestamp: " . $timestamp);
  48. }
  49. } else {
  50. //Example usage with $_GET data
  51. $getData = $_GET;
  52. $internalMetadata = [
  53. 'submission_timestamp' => time(),
  54. 'user_agent' => $_SERVER['HTTP_USER_AGENT'],
  55. 'request_ip' => $_SERVER['REMOTE_ADDR'],
  56. 'request_method' => $_SERVER['REQUEST_METHOD']
  57. ];
  59. $metadataWithGet = addMetadataToData($getData, $internalMetadata);
  61. // Now $metadataWithGet contains the original GET data plus the metadata.
  62. // You can then process $metadataWithGet for your internal tooling.
  63. // For example:
  64. // error_log(print_r($metadataWithGet, true)); //Log the data to a file.
  65. }
  67. ?>

Add your comment