Skip to content

Commit e92ab1d

Browse files
anzinanzin
committed
Merge branch 'mainline-entity-manager' of github.com:magento/magento2-phpstorm-plugin into add-generator-for-delete-controller
2 parents 79111d5 + 572aa55 commit e92ab1d

File tree

17 files changed

+499
-23
lines changed

17 files changed

+499
-23
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@
239239
<internalFileTemplate name="Magento Entity New Action Controller Class"/>
240240
<internalFileTemplate name="Magento New Entity Layout XML"/>
241241
<internalFileTemplate name="Magento Delete Entity By Id Command"/>
242+
<internalFileTemplate name="Magento Entity Edit Action Controller Class"/>
242243
<internalFileTemplate name="Magento Entity Delete Controller Class"/>
243244

244245
<defaultLiveTemplates file="/liveTemplates/MagentoPWA.xml"/>

‎resources/fileTemplates/internal/Magento Entity Edit Action Controller Class.php.ft

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
#parse("PHP File Header.php")
3+
4+
namespace ${NAMESPACE};
5+
6+
#set($uses = ${USES})
7+
#foreach ($use in $uses.split(","))
8+
use $use;
9+
#end
10+
11+
/**
12+
* Edit ${ENTITY_NAME} entity backend controller.
13+
*/
14+
class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS}
15+
{
16+
/**
17+
* Authorization level of a basic admin session.
18+
*
19+
* @see _isAllowed()
20+
*/
21+
const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
22+
23+
/**
24+
* Edit ${ENTITY_NAME} action.
25+
*
26+
* @return ${RESULT_PAGE}|${RESULT_INTERFACE}
27+
*/
28+
public function execute()
29+
{
30+
/** @var ${RESULT_PAGE} $resultPage */
31+
$resultPage = $this->resultFactory->create(${RESULT_FACTORY}::TYPE_PAGE);
32+
$resultPage->setActiveMenu('${MENU_IDENTIFIER}');
33+
$resultPage->getConfig()->getTitle()->prepend(__('Edit ${ENTITY_NAME}'));
34+
35+
return $resultPage;
36+
}
37+
}

‎resources/fileTemplates/internal/Magento Entity Edit Action Controller Class.php.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<html lang="en">
2+
<body>
3+
<p face="verdana" size="-1">
4+
5+
</p>
6+
7+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
8+
<tr>
9+
<td colspan="3"><font face="verdana" size="-1">Template's predefined variables:</font></td>
10+
</tr>
11+
<tr>
12+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${NAMESPACE}</b></font></nobr></td>
13+
<td width="10">&nbsp;</td>
14+
<td width="100%" valign="top"><font face="verdana" size="-1"></font></td>
15+
</tr>
16+
</table>
17+
</body>
18+
</html>

‎resources/fileTemplates/internal/Magento Entity Save Controller Class.php.ft

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS}
6666
try {
6767
/** @var ${ENTITY_DTO}|${DATA_OBJECT} $entityModel */
6868
$entityModel = $this->entityDataFactory->create();
69-
$entityModel->addData($params);
69+
$entityModel->addData($params['general']);
7070
$this->saveCommand->execute($entityModel);
7171
$this->messageManager->addSuccessMessage(
7272
__('The ${ENTITY_NAME} data was saved successfully')

‎resources/fileTemplates/internal/Magento Resource Model Class.php.ft

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
2222
protected function _construct()
2323
{
2424
$this->_init('${DB_NAME}', '${ENTITY_ID_COLUMN}');
25+
$this->_useIsObjectNew = true;
2526
}
2627
}

‎resources/fileTemplates/internal/Magento Save Entity Command Model.php.ft

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ class ${CLASS_NAME}
5757
/** @var ${MODEL} $model */
5858
$model = $this->modelFactory->create();
5959
$model->addData($${DTO_PROPERTY}->getData());
60+
$model->setHasDataChanges(true);
61+
62+
if (!$model->getId()) {
63+
$model->isObjectNew(true);
64+
}
6065
$this->resource->save($model);
6166
} catch (${EXCEPTION} $exception) {
6267
$this->logger->error(

‎src/com/magento/idea/magento2plugin/actions/generation/data/EditEntityActionData.java

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
/*
2+
* Copyright © Magento, Inc. All rights reserved.
3+
* See COPYING.txt for license details.
4+
*/
5+
6+
package com.magento.idea.magento2plugin.actions.generation.data;
7+
8+
import org.jetbrains.annotations.NotNull;
9+
10+
public class EditEntityActionData {
11+
12+
private final String entityName;
13+
private final String moduleName;
14+
private final String classFqn;
15+
private final String namespace;
16+
private final String acl;
17+
private final String menuIdentifier;
18+
19+
/**
20+
* Edit action data constructor.
21+
*
22+
* @param entityName String
23+
* @param moduleName String
24+
* @param classFqn String
25+
* @param namespace String
26+
* @param acl String
27+
* @param menuIdentifier String
28+
*/
29+
public EditEntityActionData(
30+
final @NotNull String entityName,
31+
final @NotNull String moduleName,
32+
final @NotNull String classFqn,
33+
final @NotNull String namespace,
34+
final @NotNull String acl,
35+
final @NotNull String menuIdentifier
36+
) {
37+
this.entityName = entityName;
38+
this.moduleName = moduleName;
39+
this.classFqn = classFqn;
40+
this.namespace = namespace;
41+
this.acl = acl;
42+
this.menuIdentifier = menuIdentifier;
43+
}
44+
45+
/**
46+
* Get entity name.
47+
*
48+
* @return String
49+
*/
50+
public String getEntityName() {
51+
return entityName;
52+
}
53+
54+
/**
55+
* Get module name.
56+
*
57+
* @return String
58+
*/
59+
public String getModuleName() {
60+
return moduleName;
61+
}
62+
63+
/**
64+
* Get class FQN.
65+
*
66+
* @return String
67+
*/
68+
public String getClassFqn() {
69+
return classFqn;
70+
}
71+
72+
/**
73+
* Get namespace.
74+
*
75+
* @return String
76+
*/
77+
public String getNamespace() {
78+
return namespace;
79+
}
80+
81+
/**
82+
* Get acl.
83+
*
84+
* @return String
85+
*/
86+
public String getAcl() {
87+
return acl;
88+
}
89+
90+
/**
91+
* Get menu.
92+
*
93+
* @return String
94+
*/
95+
public String getMenu() {
96+
return menuIdentifier;
97+
}
98+
}

‎src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEntityDialog.java

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
import com.magento.idea.magento2plugin.actions.generation.data.AclXmlData;
1717
import com.magento.idea.magento2plugin.actions.generation.data.AdminListViewEntityActionData;
1818
import com.magento.idea.magento2plugin.actions.generation.data.CollectionData;
19-
import com.magento.idea.magento2plugin.actions.generation.data.ControllerFileData;
2019
import com.magento.idea.magento2plugin.actions.generation.data.DataModelData;
2120
import com.magento.idea.magento2plugin.actions.generation.data.DataModelInterfaceData;
2221
import com.magento.idea.magento2plugin.actions.generation.data.DbSchemaXmlData;
22+
import com.magento.idea.magento2plugin.actions.generation.data.EditEntityActionData;
2323
import com.magento.idea.magento2plugin.actions.generation.data.DeleteEntityByIdCommandData;
2424
import com.magento.idea.magento2plugin.actions.generation.data.DeleteEntityControllerFileData;
2525
import com.magento.idea.magento2plugin.actions.generation.data.EntityDataMapperData;
@@ -58,6 +58,7 @@
5858
import com.magento.idea.magento2plugin.actions.generation.generator.DataModelInterfaceGenerator;
5959
import com.magento.idea.magento2plugin.actions.generation.generator.DbSchemaWhitelistJsonGenerator;
6060
import com.magento.idea.magento2plugin.actions.generation.generator.DbSchemaXmlGenerator;
61+
import com.magento.idea.magento2plugin.actions.generation.generator.EditEntityActionGenerator;
6162
import com.magento.idea.magento2plugin.actions.generation.generator.DeleteEntityByIdCommandGenerator;
6263
import com.magento.idea.magento2plugin.actions.generation.generator.DeleteEntityControllerFileGenerator;
6364
import com.magento.idea.magento2plugin.actions.generation.generator.EntityDataMapperGenerator;
@@ -67,7 +68,6 @@
6768
import com.magento.idea.magento2plugin.actions.generation.generator.LayoutXmlGenerator;
6869
import com.magento.idea.magento2plugin.actions.generation.generator.MenuXmlGenerator;
6970
import com.magento.idea.magento2plugin.actions.generation.generator.ModuleCollectionGenerator;
70-
import com.magento.idea.magento2plugin.actions.generation.generator.ModuleControllerClassGenerator;
7171
import com.magento.idea.magento2plugin.actions.generation.generator.ModuleModelGenerator;
7272
import com.magento.idea.magento2plugin.actions.generation.generator.ModuleResourceModelGenerator;
7373
import com.magento.idea.magento2plugin.actions.generation.generator.NewActionEntityControllerFileGenerator;
@@ -91,13 +91,13 @@
9191
import com.magento.idea.magento2plugin.magento.files.ResourceModelPhp;
9292
import com.magento.idea.magento2plugin.magento.files.UiComponentDataProviderPhp;
9393
import com.magento.idea.magento2plugin.magento.files.actions.AdminListViewActionFile;
94+
import com.magento.idea.magento2plugin.magento.files.actions.EditEntityActionFile;
9495
import com.magento.idea.magento2plugin.magento.files.actions.NewActionFile;
9596
import com.magento.idea.magento2plugin.magento.files.actions.SaveActionFile;
9697
import com.magento.idea.magento2plugin.magento.files.commands.DeleteEntityByIdCommandFile;
9798
import com.magento.idea.magento2plugin.magento.files.commands.SaveEntityCommandFile;
9899
import com.magento.idea.magento2plugin.magento.packages.Areas;
99100
import com.magento.idea.magento2plugin.magento.packages.File;
100-
import com.magento.idea.magento2plugin.magento.packages.HttpMethod;
101101
import com.magento.idea.magento2plugin.magento.packages.PropertiesTypes;
102102
import com.magento.idea.magento2plugin.magento.packages.database.TableEngines;
103103
import com.magento.idea.magento2plugin.magento.packages.database.TableResources;
@@ -371,13 +371,14 @@ private void onOK() {
371371
generateDataProviderFile();
372372
generateUiComponentGridActionColumnFile();
373373
generateUiComponentGridFile();
374-
generateFormViewControllerFile();
375374
generateFormLayoutFile();
376375
generateNewEntityLayoutFile();
377376
generateSaveEntityCommandFile();
378377
generateDeleteEntityByIdCommandFile();
379378
generateFormSaveControllerFile();
380379
generateFormUiComponentGenericButtonFile();
380+
generateFormEditControllerFile();
381+
generateFormSaveControllerFile();
381382
generateFormNewActionControllerFile();
382383
generateFormDeleteControllerFile();
383384
generateUiComponentFormFile();
@@ -653,12 +654,22 @@ public String getRoute() {
653654
return route.getText().trim();
654655
}
655656

656-
private String getViewActionName() {
657+
/**
658+
* Get edit action name.
659+
*
660+
* @return String
661+
*/
662+
private String getEditActionName() {
657663
return "Edit";
658664
}
659665

666+
/**
667+
* Get submit action name.
668+
*
669+
* @return String
670+
*/
660671
private String getSubmitActionName() {
661-
return "Save";//NOPMD
672+
return "Save";
662673
}
663674

664675
private String getControllerDirectory() {
@@ -1128,24 +1139,24 @@ private String getDeleteAction() {
11281139
}
11291140

11301141
/**
1131-
* Generate form view controller file.
1142+
* Generate form edit controller file.
11321143
*/
1133-
private void generateFormViewControllerFile() {
1134-
final NamespaceBuilder namespace = new NamespaceBuilder(
1144+
private void generateFormEditControllerFile() {
1145+
final EditEntityActionFile file = new EditEntityActionFile(getEntityName());
1146+
final NamespaceBuilder editActionNamespaceBuilder = new NamespaceBuilder(
11351147
getModuleName(),
1136-
getViewActionName(),
1137-
getControllerDirectory().concat(getEntityName())
1148+
file.getClassName(),
1149+
file.getDirectory()
11381150
);
1139-
new ModuleControllerClassGenerator(new ControllerFileData(
1140-
getControllerDirectory().concat(getEntityName()),
1141-
getViewActionName(),
1151+
final EditEntityActionData data = new EditEntityActionData(
1152+
getEntityName(),
11421153
getModuleName(),
1143-
Areas.adminhtml.toString(),
1144-
HttpMethod.GET.toString(),
1154+
editActionNamespaceBuilder.getClassFqn(),
1155+
editActionNamespaceBuilder.getNamespace(),
11451156
getAcl(),
1146-
true,
1147-
namespace.getNamespace()
1148-
), project).generate(ACTION_NAME, false);
1157+
getMenuIdentifier()
1158+
);
1159+
new EditEntityActionGenerator(data, project).generate(ACTION_NAME, false);
11491160
}
11501161

11511162
/**
@@ -1157,7 +1168,7 @@ private void generateFormLayoutFile() {
11571168
getRoute(),
11581169
getModuleName(),
11591170
getEntityName(),
1160-
getViewActionName(),
1171+
getEditActionName(),
11611172
getFormName()
11621173
), project).generate(ACTION_NAME, false);
11631174
}

0 commit comments

Comments
 (0)