From 137da6340fe85f5d8e0e90b1fa7030a69f154724 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 31 Aug 2023 17:02:20 -0700
Subject: [PATCH] phpstorm - Move static rules into the dynamic folder

---
 tools/extensions/phpstorm/.phpstorm.meta.php  | 12 --------
 .../Civi/PhpStorm/PhpStormMetadata.php        |  9 ++++++
 .../Civi/PhpStorm/StaticGenerator.php         | 28 +++++++++++++++++++
 3 files changed, 37 insertions(+), 12 deletions(-)
 delete mode 100644 tools/extensions/phpstorm/.phpstorm.meta.php
 create mode 100644 tools/extensions/phpstorm/Civi/PhpStorm/StaticGenerator.php

diff --git a/tools/extensions/phpstorm/.phpstorm.meta.php b/tools/extensions/phpstorm/.phpstorm.meta.php
deleted file mode 100644
index 267bf2b113..0000000000
--- a/tools/extensions/phpstorm/.phpstorm.meta.php
+++ /dev/null
@@ -1,12 +0,0 @@
-<?php
-/**
- * This file contains IDE metadata for CiviCRM which is static (does not need to be compiled).
- *
- * Other dynamic metadata files generated by this extension can be found
- * in the `[civicrm.files]/.phpstorm.meta.php` directory.
- */
-namespace PHPSTORM_META {
-
-  exitPoint(\CRM_Utils_System::civiExit());
-
-}
diff --git a/tools/extensions/phpstorm/Civi/PhpStorm/PhpStormMetadata.php b/tools/extensions/phpstorm/Civi/PhpStorm/PhpStormMetadata.php
index 260f0ebd2e..9e88fa2c25 100644
--- a/tools/extensions/phpstorm/Civi/PhpStorm/PhpStormMetadata.php
+++ b/tools/extensions/phpstorm/Civi/PhpStorm/PhpStormMetadata.php
@@ -68,6 +68,15 @@ class PhpStormMetadata {
     return $this;
   }
 
+  /**
+   * @param string $for
+   * @return $this
+   */
+  public function addExitPoint(string $for) {
+    $this->buffer .= "exitPoint($for);\n";
+    return $this;
+  }
+
   /**
    * @param string $for
    * @param array $map
diff --git a/tools/extensions/phpstorm/Civi/PhpStorm/StaticGenerator.php b/tools/extensions/phpstorm/Civi/PhpStorm/StaticGenerator.php
new file mode 100644
index 0000000000..c550c003a8
--- /dev/null
+++ b/tools/extensions/phpstorm/Civi/PhpStorm/StaticGenerator.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Civi\PhpStorm;
+
+use Civi\Core\Service\AutoService;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Generate simple/static mappings.
+ *
+ * This could be committed directly, but generating via PhpStormMetadata means that we get the same
+ * install/upgrade/uninstall workflow as the others. (No special carve-outs per-file.)
+ *
+ * @service civi.phpstorm.static
+ */
+class StaticGenerator extends AutoService implements EventSubscriberInterface {
+
+  public static function getSubscribedEvents() {
+    return ['civi.phpstorm.flush' => 'generate'];
+  }
+
+  public function generate() {
+    $builder = new PhpStormMetadata('static', __CLASS__);
+    $builder->addExitPoint('\CRM_Utils_System::civiExit()');
+    $builder->write();
+  }
+
+}
-- 
2.25.1