1. <?php
  3. /**
  4. * Sanity checks for query string parameters.
  5. * Primarily for non-production environments.
  6. *
  7. * @param array $query_string Array of query string parameters.
  8. * @param array $required_params Array of required parameters.
  9. * @param array $optional_params Array of optional parameters with default values.
  10. * @return bool True if all checks pass, false otherwise.
  11. */
  12. function sanitizeQueryString(array $query_string, array $required_params, array $optional_params = []): bool
  13. {
  14. // Check for required parameters
  15. foreach ($required_params as $param) {
  16. if (!isset($query_string[$param]) || empty($query_string[$param])) {
  17. error_log("Missing required parameter: " . $param); //Log error
  18. return false;
  19. }
  20. }
  22. // Check for optional parameters with default values
  23. foreach ($optional_params as $param => $default_value) {
  24. if (isset($query_string[$param]) && !empty($query_string[$param])) {
  25. //Basic sanity check. Can add more complex checks here.
  26. if (!is_string($query_string[$param])) {
  27. error_log("Invalid type for optional parameter: " . $param . ". Expected string.");
  28. return false;
  29. }
  30. }
  31. }
  33. return true;
  34. }
  37. //Example Usage:
  38. /*
  39. $query_string = [
  40. 'page' => 'home',
  41. 'sort' => 'name',
  42. 'limit' => '10'
  43. ];
  45. $required_params = ['page', 'sort'];
  46. $optional_params = ['limit' => 20, 'order' => 'asc'];
  49. if (sanitizeQueryString($query_string, $required_params, $optional_params)) {
  50. echo "Query string is valid.\n";
  51. } else {
  52. echo "Query string is invalid.\n";
  53. }
  54. */
  56. ?>

Add your comment