From: Tim Otten <totten@civicrm.org>
Date: Fri, 25 Aug 2023 22:03:12 +0000 (-0700)
Subject: phpstorm - Convert "Generator" to "PhpStormCompilePass"
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=0778d8a68ae387ceca755887e5cf8359e3a942ca;p=civicrm-core.git

phpstorm - Convert "Generator" to "PhpStormCompilePass"
---

diff --git a/tools/extensions/phpstorm/Civi/PhpStorm/Generator.php b/tools/extensions/phpstorm/Civi/PhpStorm/PhpStormCompilePass.php
similarity index 90%
rename from tools/extensions/phpstorm/Civi/PhpStorm/Generator.php
rename to tools/extensions/phpstorm/Civi/PhpStorm/PhpStormCompilePass.php
index d555b4850d..8d108c150d 100644
--- a/tools/extensions/phpstorm/Civi/PhpStorm/Generator.php
+++ b/tools/extensions/phpstorm/Civi/PhpStorm/PhpStormCompilePass.php
@@ -2,6 +2,7 @@
 
 namespace Civi\PhpStorm;
 
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
@@ -9,13 +10,13 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
  *
  * @link https://www.jetbrains.com/help/phpstorm/2021.3/ide-advanced-metadata.html
  */
-class Generator {
+class PhpStormCompilePass implements CompilerPassInterface {
 
   /**
    * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
    * @return void
    */
-  public static function generate(ContainerBuilder $container): void {
+  public function process(ContainerBuilder $container): void {
     if (defined('CIVICRM_TEST')) {
       return;
     }
diff --git a/tools/extensions/phpstorm/info.xml b/tools/extensions/phpstorm/info.xml
index 8f4f17f968..6ae54c75c0 100644
--- a/tools/extensions/phpstorm/info.xml
+++ b/tools/extensions/phpstorm/info.xml
@@ -31,7 +31,6 @@
     <angularModule>crmPhpstorm</angularModule>
   </civix>
   <mixins>
-    <mixin>phpstorm@1.0.0</mixin>
     <!--
     <mixin>mgd-php@1.0.0</mixin>
     <mixin>setting-php@1.0.0</mixin>
diff --git a/tools/extensions/phpstorm/mixin/phpstorm@1.0.0.mixin.php b/tools/extensions/phpstorm/mixin/phpstorm@1.0.0.mixin.php
deleted file mode 100644
index c70b85be52..0000000000
--- a/tools/extensions/phpstorm/mixin/phpstorm@1.0.0.mixin.php
+++ /dev/null
@@ -1,22 +0,0 @@
-<?php
-
-/**
- * @mixinName phpstorm
- * @mixinVersion 1.0.0
- *
- * @param CRM_Extension_MixInfo $mixInfo
- *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
- * @param \CRM_Extension_BootCache $bootCache
- *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
- */
-return function ($mixInfo, $bootCache) {
-
-  // We want to register a late-stage listener for hook_civicrm_container, but... it's a special hook.
-  // Therefore, we apply the Shenanigan technique.
-  Civi::dispatcher()->addListener('&hook_civicrm_container', function($container) use ($mixInfo) {
-    if ($mixInfo->isActive()) {
-      \Civi\PhpStorm\Generator::generate($container);
-    }
-  }, -2000);
-
-};
diff --git a/tools/extensions/phpstorm/phpstorm.php b/tools/extensions/phpstorm/phpstorm.php
index b7d7483201..71a5085f44 100644
--- a/tools/extensions/phpstorm/phpstorm.php
+++ b/tools/extensions/phpstorm/phpstorm.php
@@ -4,6 +4,7 @@
 // phpcs:disable
 // use CRM_Phpstorm_ExtensionUtil as E;
 // phpcs:enable
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 
 /**
  * Implements hook_civicrm_config().
@@ -13,3 +14,7 @@
 // function phpstorm_civicrm_config(&$config): void {
 //  _phpstorm_civix_civicrm_config($config);
 // }
+
+function phpstorm_civicrm_container(\Symfony\Component\DependencyInjection\ContainerBuilder $container) {
+  $container->addCompilerPass(new \Civi\PhpStorm\PhpStormCompilePass(), PassConfig::TYPE_AFTER_REMOVING, 2000);
+}