Skip to content

Commit 5c7cbb1

Browse files
shyimshyim
committed
feat: Add CreateEventListenerIntention
1 parent ced2390 commit 5c7cbb1

File tree

7 files changed

+192
-3
lines changed

7 files changed

+192
-3
lines changed

‎gradle.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
pluginGroup = com.github.shyim.shopware6
55
pluginName=shopware6-phpstorm-plugin
6-
pluginVersion=0.0.14
6+
pluginVersion=0.0.15
77

88
# See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
99
# for insight into build numbers and IntelliJ Platform versions.

‎src/main/kotlin/de/shyim/shopware6/intentions/CreateEventListenerIntention.kt

+153
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
package de.shyim.shopware6.intentions
2+
3+
import com.intellij.codeInsight.intention.PsiElementBaseIntentionAction
4+
import com.intellij.openapi.application.ApplicationManager
5+
import com.intellij.openapi.command.CommandProcessor
6+
import com.intellij.openapi.editor.Editor
7+
import com.intellij.openapi.fileEditor.FileEditorManager
8+
import com.intellij.openapi.fileEditor.OpenFileDescriptor
9+
import com.intellij.openapi.project.Project
10+
import com.intellij.openapi.ui.Messages
11+
import com.intellij.openapi.ui.popup.PopupChooserBuilder
12+
import com.intellij.openapi.vfs.LocalFileSystem
13+
import com.intellij.psi.*
14+
import com.intellij.ui.components.JBList
15+
import com.jetbrains.php.lang.PhpFileType
16+
import com.jetbrains.php.lang.psi.elements.PhpClass
17+
import com.jetbrains.php.roots.PhpNamespaceByFilesProvider
18+
import de.shyim.shopware6.index.dict.ShopwareBundle
19+
import de.shyim.shopware6.templates.ShopwareTemplates
20+
import de.shyim.shopware6.util.ShopwareBundleUtil
21+
import java.awt.Component
22+
import javax.swing.JLabel
23+
import javax.swing.JList
24+
25+
class CreateEventListenerIntention : PsiElementBaseIntentionAction() {
26+
override fun getFamilyName() = "Subscribe to this event using a event listener"
27+
override fun getText() = "Subscribe to this event using a event listener"
28+
29+
override fun isAvailable(project: Project, editor: Editor?, element: PsiElement): Boolean {
30+
if (element.parent !is PhpClass || editor == null) {
31+
return false
32+
}
33+
34+
val phpClass = element.parent as PhpClass
35+
var currentClass = phpClass
36+
37+
while (true) {
38+
if (currentClass.superFQN === null || currentClass.supers.isEmpty()) {
39+
return false
40+
}
41+
42+
if (currentClass.superFQN == "\\Symfony\\Contracts\\EventDispatcher\\Event") {
43+
return true
44+
} else {
45+
currentClass = currentClass.supers[0]
46+
}
47+
}
48+
}
49+
50+
override fun invoke(project: Project, editor: Editor?, element: PsiElement) {
51+
val phpClass = element.parent as PhpClass
52+
53+
val bundleList = ShopwareBundleUtil.getAllBundles(project).filter {
54+
val virtualFile = LocalFileSystem.getInstance().findFileByPath(it.path)!!
55+
val psiFile = PsiManager.getInstance(project).findFile(virtualFile)!!
56+
57+
return@filter psiFile.manager.isInProject(psiFile)
58+
}.sortedBy { shopwareBundle -> shopwareBundle.name }
59+
60+
val jbBundleList = JBList(bundleList)
61+
62+
jbBundleList.cellRenderer = object : JBList.StripedListCellRenderer() {
63+
override fun getListCellRendererComponent(
64+
list: JList<*>?,
65+
value: Any?,
66+
index: Int,
67+
isSelected: Boolean,
68+
cellHasFocus: Boolean
69+
): Component {
70+
val renderer = super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus)
71+
72+
if (renderer is JLabel && value is ShopwareBundle) {
73+
renderer.text = value.name
74+
}
75+
76+
return renderer
77+
}
78+
}
79+
80+
PopupChooserBuilder(jbBundleList)
81+
.setTitle("Shopware: Select bundle")
82+
.setItemChoosenCallback {
83+
CommandProcessor.getInstance().executeCommand(project, {
84+
ApplicationManager.getApplication().runWriteAction {
85+
this.createEventListener(
86+
jbBundleList.selectedValue!!,
87+
phpClass.fqn,
88+
project
89+
)
90+
}
91+
}, "Create event listener", null)
92+
}
93+
.createPopup()
94+
.showInBestPositionFor(editor!!)
95+
}
96+
97+
private fun createEventListener(bundle: ShopwareBundle, eventClassName: String, project: Project) {
98+
val classParts = eventClassName.split("\\")
99+
val eventShort = classParts.get(classParts.size - 1)
100+
val className = "${eventShort}Listener"
101+
val classFileName = "${eventShort}Listener.php"
102+
103+
val bundleFile = LocalFileSystem.getInstance().findFileByPath(bundle.path)!!
104+
val bundleFolder = PsiManager.getInstance(project).findFile(bundleFile)!!.containingDirectory
105+
var expectedFolder = bundleFolder.findSubdirectory("EventListener")
106+
107+
if (expectedFolder == null) {
108+
expectedFolder = bundleFolder.createSubdirectory("EventListener")
109+
}
110+
111+
if (expectedFolder.findFile(classFileName) != null) {
112+
Messages.showInfoMessage("File exists", "Error")
113+
return
114+
}
115+
116+
val content = ShopwareTemplates.applyShopwarePHPEventListener(
117+
project, mapOf(
118+
"NAMESPACE" to getNamespaceOfFolder(expectedFolder).replace("\\\\", "\\"),
119+
"EVENT" to eventClassName.substring(1),
120+
"EVENT_SHORT" to eventShort,
121+
"CLASSNAME" to className,
122+
)
123+
)
124+
125+
val factory = PsiFileFactory.getInstance(project)
126+
val file = factory.createFileFromText(classFileName, PhpFileType.INSTANCE, content)
127+
expectedFolder.add(file)
128+
129+
FileEditorManager.getInstance(project)
130+
.openTextEditor(OpenFileDescriptor(project, expectedFolder.findFile(classFileName)!!.virtualFile), true)
131+
?: return
132+
}
133+
134+
private fun getNamespaceOfFolder(folder: PsiDirectory): String {
135+
val namespaces = PhpNamespaceByFilesProvider.INSTANCE.suggestNamespaces(folder)
136+
137+
if (namespaces != null && namespaces.size > 0) {
138+
return namespaces.get(0)
139+
}
140+
141+
val superNamespaces = PhpNamespaceByFilesProvider.INSTANCE.suggestNamespaces(folder.parent!!)
142+
143+
if (superNamespaces != null && superNamespaces.size > 0) {
144+
return superNamespaces.get(0) + "\\\\" + folder.name
145+
}
146+
147+
return ""
148+
}
149+
150+
override fun checkFile(file: PsiFile?): Boolean {
151+
return true
152+
}
153+
}

‎src/main/kotlin/de/shyim/shopware6/intentions/ExtendTwigBlockIntention.kt

-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ class ExtendTwigBlockIntention : PsiElementBaseIntentionAction() {
8787
)
8888
}
8989
}, "Extend Twig block", null)
90-
println(jbBundleList.selectedValue)
9190
}
9291
.createPopup()
9392
.showInBestPositionFor(editor)

‎src/main/kotlin/de/shyim/shopware6/templates/ShopwareTemplates.kt

+15-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ class ShopwareTemplates: FileTemplateGroupDescriptorFactory {
2121
pluginGroup.addTemplate(FileTemplateDescriptor(SHOPWARE_CONTRIBUTION_CHANGELOG_TEMPLATE))
2222
}
2323

24+
FileTemplateGroupDescriptor("PP", ShopwareToolBoxIcons.SHOPWARE).let { pluginGroup ->
25+
group.addTemplate(pluginGroup)
26+
pluginGroup.addTemplate(FileTemplateDescriptor(SHOPWARE_PHP_SCHEDULED_TASK))
27+
pluginGroup.addTemplate(FileTemplateDescriptor(SHOPWARE_PHP_SCHEDULED_TASK_HANDLER))
28+
pluginGroup.addTemplate(FileTemplateDescriptor(SHOPWARE_PHP_EVENT_LISTENER))
29+
}
30+
2431
FileTemplateGroupDescriptor("Administration", ShopwareToolBoxIcons.SHOPWARE).let { pluginGroup ->
2532
group.addTemplate(pluginGroup)
2633
pluginGroup.addTemplate(FileTemplateDescriptor(SHOPWARE_ADMIN_VUE_MODULE))
@@ -50,6 +57,7 @@ class ShopwareTemplates: FileTemplateGroupDescriptorFactory {
5057
const val SHOPWARE_PLUGIN_CONFIG_TEMPLATE = "Shopware Plugin config.xml"
5158
const val SHOPWARE_PHP_SCHEDULED_TASK = "Shopware PHP Scheduled Task.php"
5259
const val SHOPWARE_PHP_SCHEDULED_TASK_HANDLER = "Shopware PHP Scheduled TaskHandler.php"
60+
const val SHOPWARE_PHP_EVENT_LISTENER = "Shopware PHP Event Listener.php"
5361
const val SHOPWARE_PLUGIN_BOOTSTRAP = "Shopware Plugin Bootstrap.php"
5462
const val SHOPWARE_PLUGIN_CHANGELOG = "Shopware Plugin Changelog.md"
5563
const val SHOPWARE_PLUGIN_COMPOSER_JSON = "Shopware Plugin composer.json"
@@ -156,7 +164,13 @@ class ShopwareTemplates: FileTemplateGroupDescriptorFactory {
156164
fun applyShopwarePluginServicesXml(project: Project, config: NewPluginConfig): String {
157165
return project.applyTemplate(
158166
SHOPWARE_PLUGIN_SERVICES_XML, config.toMap()
159-
);
167+
)
168+
}
169+
170+
fun applyShopwarePHPEventListener(project: Project, config: Map<String, String>): String {
171+
return project.applyTemplate(
172+
SHOPWARE_PHP_EVENT_LISTENER, config
173+
)
160174
}
161175
}
162176

‎src/main/resources/META-INF/plugin.xml

+5
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@
8181
<className>de.shyim.shopware6.intentions.ExtendTwigBlockIntention</className>
8282
<category>Shopware</category>
8383
</intentionAction>
84+
85+
<intentionAction>
86+
<className>de.shyim.shopware6.intentions.CreateEventListenerIntention</className>
87+
<category>Shopware</category>
88+
</intentionAction>
8489
</extensions>
8590

8691
<extensions defaultExtensionNs="fr.adrienbrault.idea.symfony2plugin.extension">

‎src/main/resources/fileTemplates/j2ee/php/Shopware PHP Event Listener.php.ft

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
namespace ${NAMESPACE};
4+
5+
use ${EVENT};
6+
7+
class ${CLASSNAME}
8+
{
9+
public function __invoke(${EVENT_SHORT} $event): void
10+
{
11+
12+
}
13+
}

‎src/main/resources/intentionDescriptions/CreateEventListenerIntention/description.html

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<html>
2+
<body>
3+
Create a new Symfony event listener in selected Shopware bundle with the chosen event class
4+
</body>
5+
</html>

0 commit comments

Comments
 (0)