1. <?php
  3. /**
  4. * Recursively validates file structures with memory optimization.
  5. *
  6. * @param string $root The root directory to validate.
  7. * @param array $expected_structure An array defining the expected file/directory structure.
  8. * @param array $validated_structure An array to store the validated structure.
  9. * @param int $level The current level of recursion (for debugging/logging).
  10. * @return bool True if the structure is valid, false otherwise.
  11. */
  12. function validateFileStructureRecursive(string $root, array $expected_structure, array &$validated_structure, int $level = 0): bool
  13. {
  14. // Check if the root directory exists
  15. if (!is_dir($root)) {
  16. error_log("Error: Root directory '$root' does not exist.");
  17. return false;
  18. }
  20. // Initialize validated structure if it's not already
  21. if (!isset($validated_structure[$root])) {
  22. $validated_structure[$root] = [];
  23. }
  25. // Iterate through the expected structure.
  26. foreach ($expected_structure as $item => $expected_type) {
  27. $full_path = $root . '/' . $item;
  29. // Check if the item exists.
  30. if (!is_dir($full_path) && !file_exists($full_path)) {
  31. error_log("Error: Expected item '$item' not found at '$full_path'.");
  32. return false;
  33. }
  35. //Validate based on expected type.
  36. if ($expected_type == 'directory') {
  37. //If it's a directory, recursively call the function.
  38. if (!is_dir($full_path)) {
  39. error_log("Error: '$full_path' is not a directory, but expected one.");
  40. return false;
  41. }
  42. if (!validateFileStructureRecursive($full_path, $expected_structure, $validated_structure, $level + 1)) {
  43. return false;
  44. }
  45. } elseif ($expected_type == 'file') {
  46. // Check if it's a file.
  47. if (!file_exists($full_path)) {
  48. error_log("Error: Expected file '$full_path' not found.");
  49. return false;
  50. }
  51. if (is_dir($full_path)) {
  52. error_log("Error: '$full_path' is a directory, but expected a file.");
  53. return false;
  54. }
  55. } else {
  56. error_log("Error: Invalid expected type '$expected_type' for item '$item'.");
  57. return false;
  58. }
  59. }
  61. //Add the validated structure to the main validated structure
  62. $validated_structure[$root] = $validated_structure[$root] ?? [];
  63. return true;
  64. }
  68. /**
  69. * Main function to call the validation process.
  70. *
  71. * @param string $root The root directory to validate.
  72. * @param array $expected_structure An array defining the expected file/directory structure.
  73. * @return bool True if the structure is valid, false otherwise.
  74. */
  75. function validateStructure(string $root, array $expected_structure): bool
  76. {
  77. $validated_structure = []; //Initialize the validated structure.
  78. return validateFileStructureRecursive($root, $expected_structure, $validated_structure);
  79. }
  81. //Example Usage:
  82. /*
  83. $expected_structure = [
  84. 'src' => 'directory',
  85. 'src/main.php' => 'file',
  86. 'src/helpers' => 'directory',
  87. 'src/helpers/utils.php' => 'file',
  88. 'tests' => 'directory',
  89. ];
  91. $root_directory = './my_project'; // Replace with your project root.
  93. if (validateStructure($root_directory, $expected_structure)) {
  94. echo "File structure is valid.\n";
  95. } else {
  96. echo "File structure is invalid.\n";
  97. }
  98. */
  100. ?>

Add your comment