1. <?php
  3. /**
  4. * Attaches metadata to HTTP requests for internal tooling.
  5. *
  6. * @param array $options An associative array of options.
  7. * 'request_id' => Unique identifier for the request.
  8. * 'user_id' => User ID making the request.
  9. * 'custom_data' => Associative array of custom data.
  10. * @return array|false Returns an array of headers to add, or false on error.
  11. */
  12. function attachRequestMetadata(array $options): array|false
  13. {
  14. // Validate options
  15. if (empty($options) || !isset($options['request_id'])) {
  16. error_log("Missing 'request_id' option.");
  17. return false;
  18. }
  20. $request_id = $options['request_id'];
  21. $user_id = isset($options['user_id']) ? $options['user_id'] : 'anonymous'; // Default to anonymous if not provided
  22. $custom_data = isset($options['custom_data']) ? $options['custom_data'] : [];
  25. // Build headers
  26. $headers = [];
  28. // Request ID
  29. $headers[] = 'X-Request-ID: ' . $request_id;
  31. // User ID
  32. $headers[] = 'X-User-ID: ' . $user_id;
  34. // Custom Data
  35. foreach ($custom_data as $key => $value) {
  36. $headers[] = 'X-Custom-' . $key . ': ' . $value;
  37. }
  39. return $headers;
  40. }
  42. /**
  43. * Example usage (replace with your actual framework/application integration)
  44. */
  45. if (PHP_SAPI === 'cli') {
  46. $options = [
  47. 'request_id' => uniqid(),
  48. 'user_id' => '123',
  49. 'custom_data' => [
  50. 'environment' => 'development',
  51. 'version' => '1.0',
  52. ],
  53. ];
  55. $headers = attachRequestMetadata($options);
  57. if ($headers !== false) {
  58. foreach ($headers as $header) {
  59. echo $header . "\n";
  60. }
  61. } else {
  62. echo "Error attaching metadata.\n";
  63. }
  65. }
  67. ?>

Add your comment