Merge pull request #24348 from totten/master-class-err

ClassScanner - Throw an exception if a class-file doesn't have the expected class
civicrm · Aug 23, 2022 · 0ea48af · 0ea48af
2 parents 5820d17 + 4cd22a3
commit 0ea48af
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/Civi/Core/ClassScanner.php b/Civi/Core/ClassScanner.php
@@ -137,8 +137,10 @@ private static function scanCoreClasses(): array {
     static::scanFolders($classes, $civicrmRoot, 'Civi/WorkflowMessage', '\\');
     static::scanFolders($classes, $civicrmRoot, 'CRM/*/Import', '_');
     if (\CRM_Utils_Constant::value('CIVICRM_UF') === 'UnitTests') {
-      static::scanFolders($classes, $civicrmRoot . 'tests/phpunit', 'CRM/*/WorkflowMessage', '_');
-      static::scanFolders($classes, $civicrmRoot . 'tests/phpunit', 'Civi/*/WorkflowMessage', '\\');
+      if (strpos(get_include_path(), $civicrmRoot . 'tests/phpunit') !== FALSE) {
+        static::scanFolders($classes, $civicrmRoot . 'tests/phpunit', 'CRM/*/WorkflowMessage', '_');
+        static::scanFolders($classes, $civicrmRoot . 'tests/phpunit', 'Civi/*/WorkflowMessage', '\\');
+      }
     }
 
     $cache->set($cacheKey, $classes, static::TTL);
@@ -198,6 +200,10 @@ public static function scanFolders(array &$classes, string $classRoot, string $c
             $classes[] = $class;
           }
         }
+        elseif (!interface_exists($class) && !trait_exists($class)) {
+          // If you get this error, then perhaps (a) you need to fix the name of file/class/namespace or (b) you should disable class-scanning.
+          throw new \RuntimeException("Scanned file {$relFile} for class {$class}, but it was not found.");
+        }
       }
     }
   }