Новый алгоритм поиска классов

Author: webarchitect609

src/main/BitrixNeverInclude.php

@@ -4,80 +4,14 @@
 
 use Bitrix\Main\Loader;
 use RuntimeException;
+use WebArch\BitrixCache\BitrixCache;
 
 class BitrixNeverInclude
 {
-
- /**
- * @var BitrixNeverInclude
- */
- protected static $instance;
-
  /**
- * @return array
+ * Тег для кеша маппинга глобальных классов из старых модулей
  */
- protected function getModulePrefixMap()
- {
- //TODO Изменить способ определения - определять сразу по имени класса без всяких префиксов, что вычислительно быстрее!в
- return [
-
- 'iblock' => [
- 'CIBlock',
- '_CIB',
- 'CAllIBlock',
- 'CEventIblock',
- 'CRatingsComponentsIBlock',
- ],
-
- 'catalog' => [
- 'CCatalog',
- 'CExtra',
- 'CPrice',
- 'CGlobalCond',
- ],
-
- 'sale' => [
- 'CSale',
- 'CBaseSale',
- 'IBXSale',
- 'IPayment',
- 'IShipment',
- 'CAdminSale',
- ],
-
- 'form' => [
- 'CForm',
- 'CAllForm',
- ],
-
- 'highloadblock' => [
- 'CUserTypeHlblock',
- 'CIBlockPropertyDirectory',
- ],
-
- 'idea' => [
- 'CIdeaManagment',
- ],
-
- ];
- }
-
- protected function __construct()
- {
-
- }
-
- /**
- * @return BitrixNeverInclude
- */
- protected function getInstance()
- {
- if (is_null(static::$instance)) {
- static::$instance = new static();
- }
-
- return static::$instance;
- }
+ const CACHE_TAG = 'BitrixNeverInclude';
 
  /**
  * Зарегистрировать автолоадер модулей Битрикс
@@ -87,11 +21,34 @@ protected function getInstance()
  */
  public static function registerModuleAutoload()
  {
- if (!spl_autoload_register([static::getInstance(), 'autoloadModule'])) {
+ if (!spl_autoload_register([(new static()), 'autoloadModule'])) {
  throw new RuntimeException('Error register autoloader ' . __CLASS__);
  }
  }
 
+ /**
+ * Возвращает маппинг имени модуля по имени класса. Имя класса всегда в нижнем регистре, т.к. сам Битрикс к нему
+ * преобразует.
+ *
+ * Рекомендуется назначить вызов этого метода в конце сброса всего кеша, чтобы при следующем хите он уже был создан.
+ *
+ * @return array
+ */
+ public static function getClassMapping()
+ {
+ $closure = function () {
+ $tools = new Tools();
+ $tools->includeAllInstalledModules();
+
+ return $tools->getModuleByClassNameMapping($tools->getAutoLoadClasses());
+ };
+
+ return (new BitrixCache())
+ ->withTime(86400)
+ ->withTag(self::CACHE_TAG)
+ ->resultOf($closure);
+ }
+
  /**
  * @param string $class
  */
@@ -113,48 +70,37 @@ protected function autoloadModule($class)
  }
 
  /**
- * Определение имени модуля по префиксу класса
+ * Определение модуля для старых классов из глобальной области
  *
  * @param string $class
  *
  * @return string Пустая строка, если не удалось определить имя модуля
  */
- protected function checkPrefix($class)
+ protected function recognizeOldModule($class)
  {
-
- foreach (static::getModulePrefixMap() as $moduleName => $prefixList) {
- foreach ($prefixList as $prefix) {
- if (strpos($class, $prefix) === 0) {
- return (string)$moduleName;
- }
- }
+ if (strpos($class, '\\') !== false) {
+ return '';
  }
 
- return '';
+ return $this->checkClassMapping($class);
  }
 
  /**
- * Определение модуля для старых классов из глобальной области
- *
  * @param string $class
  *
- * @return string Пустая строка, если не удалось определить имя модуля
+ * @return string
  */
- protected function recognizeOldModule($class)
+ private function checkClassMapping($class)
  {
- /*
- * Если содержит обратный слеш или не начинается с 'C' или 'I',
- * то это не старый класс из глобальной области
- */
- $first = substr($class, 0, 1);
- if (
- ($first !== 'C' && $first !== 'I')
- || strpos($class, '\\') !== false
- ) {
+ $lowClass = strtolower(trim($class));
+
+ $classMapping = static::getClassMapping();
+
+ if (!isset($classMapping[$lowClass])) {
  return '';
  }
 
- return $this->checkPrefix($class);
+ return (string)$classMapping[$lowClass];
  }
 
  /**
@@ -179,11 +125,7 @@ protected function recognizeNewModule($class)
  * Иной кастомный модуль
  */
  if (isset($chunks[0], $chunks[1])) {
- return sprintf(
- '%s.%s',
- strtolower($chunks[0]),
- strtolower($chunks[1])
- );
+ return strtolower($chunks[0] . '.' . $chunks[1]);
  }
 
  return '';

src/main/Tools.php

@@ -34,16 +34,32 @@ public function getAutoLoadClasses()
  return $staticProperties['arAutoLoadClasses'];
  }
 
- public function getClassNameMap(array $autoLoadClasses)
+ /**
+ * Вернуть индекс модуля по имени класса
+ *
+ * @param array $autoLoadClasses
+ *
+ * @return array
+ */
+ public function getModuleByClassNameMapping(array $autoLoadClasses)
  {
  $map = [];
 
  foreach ($autoLoadClasses as $className => $data) {
- if (!isset($data['module'])) {
+
+ /**
+ * Нас не интересует модуль `main`, т.к. всегда подключён.
+ * Также не интересуют классы не из глобального namespace
+ */
+ if (
+ !isset($data['module'])
+ || 'main' === $data['module']
+ || strpos($className, '\\') !== false
+ ) {
  continue;
  }
 
- $map[$data['module']][] = $className;
+ $map[$className] = $data['module'];
  }
 
  return $map;