farmOS-dev/vendor/chi-teck/drupal-code-generator/src/Helper/Drupal/HookInfo.php

<?php

declare(strict_types=1);

namespace DrupalCodeGenerator\Helper\Drupal;

use Drupal\Core\Extension\ModuleHandlerInterface;
use Symfony\Component\Console\Helper\Helper;

/**
 * Provides information about available Drupal hooks.
 */
final class HookInfo extends Helper {

  /**
   * Constructs helper.
   */
  public function __construct(private readonly ModuleHandlerInterface $moduleHandler) {}

  /**
   * {@inheritdoc}
   */
  public function getName(): string {
    return 'hook_info';
  }

  /**
   * Gets templates for all available hooks.
   *
   * @psalm-return array<string, string>
   */
  public function getHookTemplates(): array {
    static $hooks;
    if ($hooks) {
      return $hooks;
    }

    $core_api_files = \glob(\DRUPAL_ROOT . '/core/lib/Drupal/Core/*/*.api.php');
    $core_api_files[] = \DRUPAL_ROOT . '/core/core.api.php';

    $module_api_files = [];
    foreach ($this->moduleHandler->getModuleList() as $machine_name => $module) {
      $api_file = \DRUPAL_ROOT . '/' . $module->getPath() . '/' . $machine_name . '.api.php';
      if (\file_exists($api_file)) {
        $module_api_files[] = $api_file;
      }
    }

    $api_files = \array_merge($core_api_files, $module_api_files);

    $reducer = static fn (array $collected, string $api_file): array => \array_merge($collected, self::parseHooks($api_file));

    return \array_reduce($api_files, $reducer, []);

  }

  /**
   * Returns filetype of a hook.
   */
  public static function getFileType(string $hook_name): string {
    // Some Drupal hooks are not defined in MODULE_NAME.module file.
    return match ($hook_name) {
      'install',
      'uninstall',
      'schema',
      'requirements',
      'update_N',
      'update_last_removed' => 'install',
      // See views_hook_info().
      'views_data',
      'views_data_alter',
      'views_analyze',
      'views_invalidate_cache',
      'field_views_data',
      'field_views_data_alter',
        // See \Drupal\views\views::$plugins.
      'views_plugins_access_alter',
      'views_plugins_area_alter',
      'views_plugins_argument_alter',
      'views_plugins_argument_default_alter',
      'views_plugins_argument_validator_alter',
      'views_plugins_cache_alter',
      'views_plugins_display_extender_alter',
      'views_plugins_display_alter',
      'views_plugins_exposed_form_alter',
      'views_plugins_field_alter',
      'views_plugins_filter_alter',
      'views_plugins_join_alter',
      'views_plugins_pager_alter',
      'views_plugins_query_alter',
      'views_plugins_relationship_alter',
      'views_plugins_row_alter',
      'views_plugins_sort_alter',
      'views_plugins_style_alter',
      'views_plugins_wizard_alter' => 'views.inc',
      'views_query_substitutions',
      'views_form_substitutions',
      'views_pre_view',
      'views_pre_build',
      'views_post_build',
      'views_pre_execute',
      'views_post_execute',
      'views_pre_render',
      'views_post_render',
      'views_query_alter' => 'views_execution.inc',
      'token_info',
      'token_info_alter',
      'tokens',
      'tokens_alter' => 'tokens.inc',
      'post_update_NAME' => 'post_update.php',
      default => 'module',
    };
  }

  /**
   * Creates hook templates from PHP file.
   *
   * @psalm-return array<string, string>
   */
  private static function parseHooks(string $file): array {

    \preg_match_all(
      "/function hook_(?P<name>.*)\(.*\n\}\n/Us",
      \file_get_contents($file),
      $matches,
    );

    /** @psalm-var array{0: array, 1: array, name: array} $matches */
    $results = [];
    foreach ($matches[0] as $index => $hook_code) {
      $hook_name = $matches['name'][$index];
      $results[$hook_name] = self::buildHookTemplate($hook_name, $hook_code);
    }

    return $results;
  }

  /**
   * Builds hook template from PHP code.
   */
  private static function buildHookTemplate(string $hook_name, string $hook_code): string {
    $hook_template = \str_replace('function hook_', 'function {{ machine_name }}_', $hook_code);

    // Add 'void' return type when it is clear that the hook returns nothing.
    // @todo Remove this once Drupal adds return typehints for hooks.
    if (!\str_contains($hook_template, 'return')) {
      $hook_template = \preg_replace('#^(function \{\{ machine_name \}\}_.+\)) \{$#m', '\1: void {', $hook_template);
    }

    $file_description = self::getFileDescription(self::getFileType($hook_name));
    return <<< TWIG
      <?php

      declare(strict_types=1);

      /**
       * @file
       * $file_description
       */

      /**
       * Implements hook_$hook_name().
       */
      $hook_template
      TWIG;
  }

  /**
   * Gets file description.
   */
  private static function getFileDescription(string $file_type): string {
    return match($file_type) {
      'install' => 'Install, update and uninstall functions for the {{ name }} module.',
      'module' => 'Primary module hooks for {{ name }} module.',
      'post_update.php' => 'Post update functions for the {{ name }} module.',
      'tokens.inc' => 'Builds tokens for the {{ name }} module.',
      'views.inc' => 'Views hooks for the {{ name }} module.',
      'views_execution.inc' => 'Provide views runtime hooks for the {{ name }} module.',
      default => throw new \InvalidArgumentException('Unsupported file type.'),
    };
  }

}