Issue #3478621 by catch, nicxvan, longwave, alexpott: Add filecache to OOP hook attribute parsing

use Drupal\Component\Annotation\Doctrine\StaticReflectionParser;

use Drupal\Component\Annotation\Reflection\MockFileFinder;

use Drupal\Component\FileCache\FileCacheFactory;

use Drupal\Core\Extension\ProceduralCall;

use Drupal\Core\Hook\Attribute\Hook;

use Drupal\Core\Hook\Attribute\LegacyHook;

   * @return void

   */

  protected function collectModuleHookImplementations($dir, $module, $module_preg): void {

    $hook_file_cache = FileCacheFactory::get('hook_implementations');

    $procedural_hook_file_cache = FileCacheFactory::get('procedural_hook_implementations:' . $module_preg);

    $iterator = new \RecursiveDirectoryIterator($dir, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::UNIX_PATHS | \FilesystemIterator::FOLLOW_SYMLINKS);

    $iterator = new \RecursiveCallbackFilterIterator($iterator, static::filterIterator(...));

    $iterator = new \RecursiveIteratorIterator($iterator);

    foreach ($iterator as $fileinfo) {

      assert($fileinfo instanceof \SplFileInfo);

      $extension = $fileinfo->getExtension();

      $filename = $fileinfo->getPathname();

      if ($extension === 'module' && !$iterator->getDepth()) {

        // There is an expectation for all modules to be loaded. However,

        // .module files are not supposed to be in subdirectories.

        include_once $fileinfo->getPathname();

        include_once $filename;

      }

      if ($extension === 'php') {

        $cached = $hook_file_cache->get($filename);

        if ($cached) {

          $class = $cached['class'];

          $attributes = $cached['attributes'];

        }

        else {

          $namespace = preg_replace('#^src/#', "Drupal/$module/", $iterator->getSubPath());

          $class = $namespace . '/' . $fileinfo->getBasename('.php');

          $class = str_replace('/', '\\', $class);

        foreach (static::getHookAttributesInClass($class) as $attribute) {

          if (class_exists($class)) {

            $attributes = static::getHookAttributesInClass($class);

            $hook_file_cache->set($filename, ['class' => $class, 'attributes' => $attributes]);

          }

          else {

            $attributes = [];

          }

        }

        foreach ($attributes as $attribute) {

          $this->addFromAttribute($attribute, $class, $module);

        }

      }

      else {

        $finder = MockFileFinder::create($fileinfo->getPathName());

        $implementations = $procedural_hook_file_cache->get($filename);

        if ($implementations === NULL) {

          $finder = MockFileFinder::create($filename);

          $parser = new StaticReflectionParser('', $finder);

          $implementations = [];

          foreach ($parser->getMethodAttributes() as $function => $attributes) {

            if (!StaticReflectionParser::hasAttribute($attributes, LegacyHook::class) && preg_match($module_preg, $function, $matches)) {

            $this->addProceduralImplementation($fileinfo, $matches['hook'], $matches['module'], $matches['function']);

              $implementations[] = ['function' => $function, 'module' => $matches['module'], 'hook' => $matches['hook']];

            }

          }

          $procedural_hook_file_cache->set($filename, $implementations);

        }

        foreach ($implementations as $implementation) {

          $this->addProceduralImplementation($fileinfo, $implementation['hook'], $implementation['module'], $implementation['function']);

        }

      }

      if ($extension === 'inc') {

        $parts = explode('.', $fileinfo->getFilename());

        if (count($parts) === 3 && $parts[0] === $module) {

          $this->groupIncludes[$parts[1]][] = $fileinfo->getPathname();

          $this->groupIncludes[$parts[1]][] = $filename;

        }

      }

    }

   *   An array of Hook attributes on this class. The $method property is guaranteed to be set.

   */

  protected static function getHookAttributesInClass(string $class): array {

    if (!class_exists($class)) {

      return [];

    }

    $reflection_class = new \ReflectionClass($class);

    $class_implementations = [];

    // Check for #[Hook] on the class itself.

name: 'Test Hooks on behalf of other modules'

type: module

description: 'Test hooks invoked on behalf of other modules when installed later.'

package: Testing

version: VERSION

<?php

declare(strict_types=1);

namespace Drupal\hook_collector_on_behalf\Hook;

use Drupal\Core\Hook\Attribute\Hook;

/**

 * Hook implementation on behalf of another module.

 */

class OnBehalfOfOtherModuleHook {

  /**

   * Implements hook_module_preinstall().

   */

  #[Hook('cache_flush', module: 'respond_install_uninstall_hook_test')]

  public function flush(): void {

    // Set a global value we can check in test code.

    $GLOBALS['on_behalf_oop'] = 'on_behalf_oop';

  }

}

name: 'Test Hooks on behalf of other modules'

type: module

description: 'Test hooks invoked on behalf of other modules when installed later.'

package: Testing

version: VERSION

<?php

/**

 * @file

 * Implement hooks.

 */

declare(strict_types=1);

/**

 * This implements a hook on behalf of another module.

 *

 * We do not have implements so this does not get converted.

 */

function respond_install_uninstall_hook_test_cache_flush(): void {

  // Set a global value we can check in test code.

  $GLOBALS['on_behalf_procedural'] = 'on_behalf_procedural';

}