1. <?php
  3. /**
  4. * Checks command-line options against predefined constraints.
  5. * Supports a dry-run mode.
  6. *
  7. * @param array $argv Command-line arguments.
  8. * @param array $expectedOptions Array of expected options and their constraints.
  9. * @param bool $dryRun Whether to perform a dry run (no actual actions).
  10. * @return array An array of validation errors. Empty array if valid.
  11. */
  12. function validateCommandLineOptions(array $argv, array $expectedOptions, bool $dryRun = false): array
  13. {
  14. $errors = [];
  16. foreach ($expectedOptions as $optionName => $constraints) {
  17. // Check if the option is present
  18. if (!isset($argv[$optionName])) {
  19. if ($constraints['required']) {
  20. $errors[] = "Option '$optionName' is required.";
  21. }
  22. continue; // Skip to the next option
  23. }
  25. $optionValue = $argv[$optionName];
  27. // Validate the option value based on the constraints
  28. if (isset($constraints['type'])) {
  29. switch ($constraints['type']) {
  30. case 'integer':
  31. if (!is_numeric($optionValue) || !filter_var($optionValue, FILTER_VALIDATE_INT)) {
  32. $errors[] = "Option '$optionName' must be an integer.";
  33. }
  34. break;
  35. case 'float':
  36. if (!is_numeric($optionValue) || !filter_var($optionValue, FILTER_VALIDATE_FLOAT)) {
  37. $errors[] = "Option '$optionName' must be a float.";
  38. }
  39. break;
  40. case 'string':
  41. //Simple string validation. Could add length constraints, etc.
  42. if(!is_string($optionValue)){
  43. $errors[] = "Option '$optionName' must be a string.";
  44. }
  45. break;
  46. default:
  47. $errors[] = "Unsupported type: " . $constraints['type'] . " for option '$optionName'.";
  48. }
  49. }
  51. if (isset($constraints['allowedValues'])) {
  52. if (!in_array($optionValue, $constraints['allowedValues'])) {
  53. $errors[] = "Option '$optionName' must be one of: " . implode(', ', $constraints['allowedValues']);
  54. }
  55. }
  57. if (isset($constraints['pattern'])) {
  58. if (!preg_match($constraints['pattern'], $optionValue)) {
  59. $errors[] = "Option '$optionName' does not match pattern: " . $constraints['pattern'];
  60. }
  61. }
  62. }
  64. return $errors;
  65. }
  68. // Example usage (for testing):
  69. /*
  70. $argv = ['--name', 'John Doe', '--age', '30', '--mode', 'debug'];
  71. $expectedOptions = [
  72. '--name' => ['required' => true, 'type' => 'string'],
  73. '--age' => ['required' => true, 'type' => 'integer'],
  74. '--mode' => ['required' => false, 'allowedValues' => ['debug', 'info', 'warning', 'error'], 'default' => 'info'],
  75. ];
  77. $errors = validateCommandLineOptions($argv, $expectedOptions, false); // Run validation
  78. if (empty($errors)) {
  79. echo "Command-line options are valid.\n";
  80. } else {
  81. echo "Validation errors:\n";
  82. foreach ($errors as $error) {
  83. echo "- " . $error . "\n";
  84. }
  85. }
  87. $argv2 = ['--name', 'John Doe', '--age', 'abc', '--mode', 'debug'];
  88. $errors2 = validateCommandLineOptions($argv2, $expectedOptions, false); // Run validation
  89. if (empty($errors2)) {
  90. echo "Command-line options are valid.\n";
  91. } else {
  92. echo "Validation errors:\n";
  93. foreach ($errors2 as $error) {
  94. echo "- " . $error . "\n";
  95. }
  96. }
  97. */
  100. ?>

Add your comment