Add phpstorm completion for OOP hooks

Author: Chi-teck

src/Command/PhpStormMeta/Hooks.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DrupalCodeGenerator\Command\PhpStormMeta;
+
+use DrupalCodeGenerator\Asset\File;
+use DrupalCodeGenerator\Helper\Drupal\HookInfo;
+use DrupalCodeGenerator\Helper\Drupal\ModuleInfo;
+
+/**
+ * Generates PhpStorm meta-data for Drupal hooks.
+ */
+final class Hooks {
+
+  /**
+   * Constructs the object.
+   */
+  public function __construct(
+    private readonly HookInfo $hookInfo,
+    private readonly ModuleInfo $moduleInfo,
+  ) {}
+
+  /**
+   * Generator callback.
+   */
+  public function __invoke(): File {
+    $hooks = \array_keys($this->hookInfo->getHookTemplates());
+    $modules = \array_keys($this->moduleInfo->getExtensions());
+    return File::create('.phpstorm.meta.php/hooks.php')
+      ->template('hooks.php.twig')
+      ->vars(['hooks' => $hooks, 'modules' => $modules]);
+  }
+
+}

src/Command/PhpStormMeta/PhpStormMeta.php

@@ -68,6 +68,7 @@ protected function generate(array &$vars, Assets $assets): void {
     $assets[] = (new FieldDefinitions($service('entity_type.manager'), $service('plugin.manager.field.field_type')))();
     $assets[] = (new Fields($service('entity_type.manager'), $service('entity_field.manager'), $entity_interface))();
     $assets[] = (new FileSystem())();
+    $assets[] = (new Hooks($this->getHelper('hook_info'), $this->getHelper('module_info')))();
     $assets[] = (new Miscellaneous())();
     $assets[] = (new Permissions($this->getHelper('permission_info')))();
     $assets[] = (new Plugins($this->getHelper('service_info')))();

templates/_phpstorm-meta/hooks.php.twig

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPSTORM_META {
+
+  registerArgumentsSet('hooks',
+{% for hook in hooks %}
+    '{{ hook }}',
+{% endfor %}
+  );
+  registerArgumentsSet('modules',
+{% for module in modules %}
+    '{{ module }}',
+{% endfor %}
+  );
+  expectedArguments(\Drupal\Core\Hook\Attribute\Hook::__construct(), 0, argumentsSet('hooks'));
+  expectedArguments(\Drupal\Core\Hook\Attribute\Hook::__construct(), 2, argumentsSet('modules'));
+
+}

tests/functional/Generator/PhpStormMetaTest.php

@@ -38,6 +38,7 @@ public function testGenerator(): void {
      • .phpstorm.meta.php/field_definitions.php
      • .phpstorm.meta.php/fields.php
      • .phpstorm.meta.php/file_system.php
+     • .phpstorm.meta.php/hooks.php
      • .phpstorm.meta.php/miscellaneous.php
      • .phpstorm.meta.php/permissions.php
      • .phpstorm.meta.php/plugins.php
@@ -71,6 +72,7 @@ public function testGenerator(): void {
     $this->assertMiscellaneous();
     $this->assertRoles();
     $this->assertRoutes();
+    $this->assertHooks();
   }
 
   /**
@@ -715,4 +717,44 @@ private function assertRoutes(): void {
     self::assertStringContainsString($arguments, $generated_content);
   }
 
+  private function assertHooks(): void {
+    $generated_content = $this->getGeneratedContent('.phpstorm.meta.php/hooks.php');
+
+    $hooks = <<< 'PHP'
+      <?php
+
+      declare(strict_types=1);
+
+      namespace PHPSTORM_META {
+
+        registerArgumentsSet('hooks',
+          'query_alter',
+          'query_TAG_alter',
+          'schema',
+          'entity_access',
+          'ENTITY_TYPE_access',
+          'entity_create_access',
+          'ENTITY_TYPE_create_access',
+          'entity_type_build',
+      PHP;
+    self::assertStringContainsString($hooks, $generated_content);
+
+    $modules = <<< 'PHP'
+        registerArgumentsSet('modules',
+          'announcements_feed',
+          'automated_cron',
+          'big_pipe',
+          'block',
+          'block_content',
+          'breakpoint',
+      PHP;
+    self::assertStringContainsString($modules, $generated_content);
+
+    $arguments = <<< 'PHP'
+        expectedArguments(\Drupal\Core\Hook\Attribute\Hook::__construct(), 0, argumentsSet('hooks'));
+        expectedArguments(\Drupal\Core\Hook\Attribute\Hook::__construct(), 2, argumentsSet('modules'));
+      PHP;
+    self::assertStringContainsString($arguments, $generated_content);
+  }
+
 }