Merge pull request #7 from tommykw/feature/phpstorm-target

feat: target PhpStorm for trait viewer plugin

Author: tommykw

gradle.properties

@@ -14,7 +14,7 @@ platformVersion = 2025.2.5
 
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
 # Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP
-platformPlugins =
+platformPlugins = com.jetbrains.php:252.28238.7
 # Example: platformBundledPlugins = com.intellij.java
 platformBundledPlugins =
 # Example: platformBundledModules = intellij.spellchecker

src/main/kotlin/com/github/tommykw/phptraitinlineviewer/MyBundle.kt

@@ -0,0 +1,16 @@
+package com.github.tommykw.phptraitinlineviewer
+
+import com.intellij.notification.NotificationGroupManager
+import com.intellij.notification.NotificationType
+import com.intellij.openapi.project.Project
+
+object TraitInlineNotifier {
+    private const val GROUP_ID = "Trait Inline Viewer"
+
+    fun warn(project: Project, message: String) {
+        NotificationGroupManager.getInstance()
+            .getNotificationGroup(GROUP_ID)
+            .createNotification(message, NotificationType.WARNING)
+            .notify(project)
+    }
+}

src/main/kotlin/com/github/tommykw/phptraitinlineviewer/TraitInlineNotifier.kt

@@ -0,0 +1,79 @@
+package com.github.tommykw.phptraitinlineviewer
+
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.psi.util.PsiTreeUtil
+import com.jetbrains.php.lang.psi.PhpFile
+import com.jetbrains.php.lang.psi.elements.PhpClass
+import com.jetbrains.php.lang.psi.elements.PhpTraitUseRule
+
+class TraitInlineViewerAction : AnAction() {
+    override fun update(event: AnActionEvent) {
+        event.presentation.text = "View PHP Trait Inline"
+
+        val psiFile = event.getData(CommonDataKeys.PSI_FILE)
+        val editor = event.getData(CommonDataKeys.EDITOR)
+        val isPhpFile = psiFile is PhpFile
+
+        event.presentation.isVisible = isPhpFile
+
+        if (!isPhpFile || editor == null) {
+            event.presentation.isEnabled = false
+            event.presentation.description = "Available only inside PHP editors."
+            return
+        }
+
+        // Check if cursor is in or near a PHP trait use
+        val element = psiFile.findElementAt(editor.caretModel.offset)
+        val traitUseRule = element?.let { PsiTreeUtil.getParentOfType(it, PhpTraitUseRule::class.java) }
+        val phpClass = traitUseRule?.let { PsiTreeUtil.getParentOfType(it, PhpClass::class.java) }
+            ?: element?.let { PsiTreeUtil.getParentOfType(it, PhpClass::class.java) }
+
+        if (phpClass == null) {
+            event.presentation.isEnabled = false
+            event.presentation.description = "Place the caret inside a PHP class."
+            return
+        }
+
+        val hasTraitUses = phpClass.traitUseRules()?.isEmpty == false
+        event.presentation.isEnabled = hasTraitUses
+        event.presentation.description = if (hasTraitUses) {
+            "Open an inline view of ${phpClass.name ?: "this class"} with merged traits."
+        } else {
+            "No trait use statements found in ${phpClass.name ?: "this class"}."
+        }
+    }
+
+    override fun actionPerformed(event: AnActionEvent) {
+        val project = event.project ?: return
+        val editor = event.getData(CommonDataKeys.EDITOR)
+        val psiFile = event.getData(CommonDataKeys.PSI_FILE)
+
+        if (psiFile !is PhpFile || editor == null) {
+            TraitInlineNotifier.warn(project, "Place the caret inside a PHP editor before running this action.")
+            return
+        }
+
+        val element = psiFile.findElementAt(editor.caretModel.offset)
+
+        if (element == null) {
+            TraitInlineNotifier.warn(project, "Could not locate PSI element at the caret position.")
+            return
+        }
+
+        val phpClass = PsiTreeUtil.getParentOfType(element, PhpClass::class.java)
+        if (phpClass == null) {
+            TraitInlineNotifier.warn(project, "This action must be triggered from inside a PHP class.")
+            return
+        }
+
+        if (phpClass.traitUseRules()?.isEmpty != false) {
+            TraitInlineNotifier.warn(project, "${phpClass.name ?: "This class"} does not use any traits.")
+            return
+        }
+
+        val merged = TraitMerger.mergeClassWithTraits(phpClass)
+        TraitInlineFileOpener.open(project, merged, phpClass.name ?: "Unknown")
+    }
+}

src/main/kotlin/com/github/tommykw/phptraitinlineviewer/TraitInlineViewerAction.kt

@@ -0,0 +1,49 @@
+package com.github.tommykw.phptraitinlineviewer
+
+import com.intellij.openapi.fileEditor.FileEditorManager
+import com.intellij.openapi.project.Project
+import com.intellij.testFramework.LightVirtualFile
+import com.jetbrains.php.lang.PhpFileType
+import com.jetbrains.php.lang.psi.elements.PhpClass
+
+object TraitMerger {
+    fun mergeClassWithTraits(phpClass: PhpClass): String {
+        return buildString {
+            append("<?php\n\n")
+            append("class ${phpClass.name}Merged {\n")
+
+            val traits = phpClass.traits
+
+            for (trait in traits) {
+                append("    // ===== Trait: ${trait.name} =====\n\n")
+
+                for (method in trait.methods) {
+                    append("    ")
+                    append(method.text.replace("\n", "\n    "))
+                    append("\n\n")
+                }
+
+                for (field in trait.fields) {
+                    append("    ")
+                    append(field.text.replace("\n", "\n    "))
+                    append("\n\n")
+                }
+            }
+
+            append("}\n")
+        }
+    }
+}
+
+object TraitInlineFileOpener {
+    fun open(project: Project, content: String, originalClassName: String) {
+        val file = LightVirtualFile(
+            "${originalClassName}_InlineTraits.php",
+            PhpFileType.INSTANCE,
+            content
+        )
+        file.isWritable = false
+
+        FileEditorManager.getInstance(project).openFile(file, true)
+    }
+}

src/main/kotlin/com/github/tommykw/phptraitinlineviewer/TraitMerger.kt

@@ -5,11 +5,19 @@
     <vendor>tommykw</vendor>
 
     <depends>com.intellij.modules.platform</depends>
-
-    <resource-bundle>messages.MyBundle</resource-bundle>
+    <depends>com.jetbrains.php</depends>
 
     <extensions defaultExtensionNs="com.intellij">
-        <toolWindow factoryClass="com.github.tommykw.phptraitinlineviewer.toolWindow.MyToolWindowFactory" id="MyToolWindow"/>
-        <postStartupActivity implementation="com.github.tommykw.phptraitinlineviewer.startup.MyProjectActivity" />
+        <notificationGroup id="Trait Inline Viewer" displayType="BALLOON" isLogByDefault="false"/>
     </extensions>
+
+    <actions>
+        <action id="com.github.tommykw.phptraitinlineviewer.TraitInlineViewerAction"
+                class="com.github.tommykw.phptraitinlineviewer.TraitInlineViewerAction"
+                text="View PHP Trait Inline"
+
+                description="View PHP class with traits merged inline">
+            <add-to-group group-id="EditorPopupMenu" anchor="last"/>
+        </action>
+    </actions>
 </idea-plugin>