Skip to content

Commit 4b3ea8b

Browse files
author
Vitaliy
authored
Merge pull request #470 from bohdan-harniuk/data-mapper-for-entity-manager
Added entity data mapper generator and test for generation
2 parents 1d702ef + 4e9cb66 commit 4b3ea8b

File tree

10 files changed

+566
-2
lines changed

10 files changed

+566
-2
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,7 @@
230230
<internalFileTemplate name="Magento Module Declarative Schema Whitelist JSON"/>
231231
<internalFileTemplate name="Magento Get List Query Model"/>
232232
<internalFileTemplate name="Magento Entity Save Controller Class"/>
233+
<internalFileTemplate name="Magento Entity Data Mapper"/>
233234

234235
<defaultLiveTemplates file="/liveTemplates/MagentoPWA.xml"/>
235236

‎resources/fileTemplates/code/Magento Entity Data Mapper.html.ft

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/code/Magento Entity Data Mapper.php.ft

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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+
* Converts a collection of ${ENTITY_NAME} entities to an array of data transfer objects.
13+
*/
14+
class ${CLASS_NAME}
15+
{
16+
/**
17+
* @var ${DTO_FACTORY}
18+
*/
19+
private $entityDtoFactory;
20+
21+
/**
22+
* @param ${DTO_FACTORY} $entityDtoFactory
23+
*/
24+
public function __construct(
25+
${DTO_FACTORY} $entityDtoFactory
26+
) {
27+
$this->entityDtoFactory = $entityDtoFactory;
28+
}
29+
30+
/**
31+
* Map magento models to DTO array.
32+
*
33+
* @param ${ABSTRACT_COLLECTION} $collection
34+
*
35+
* @return array|${DTO_TYPE}[]
36+
*/
37+
public function map(${ABSTRACT_COLLECTION} $collection): array
38+
{
39+
$results = [];
40+
/** @var ${MAGENTO_MODEL_TYPE} $item */
41+
foreach ($collection->getItems() as $item) {
42+
/** @var ${DTO_TYPE}|${DATA_OBJECT} $entityDto */
43+
$entityDto = $this->entityDtoFactory->create();
44+
$entityDto->addData($item->getData());
45+
46+
#set($brackets = "[]")
47+
$results$brackets = $entityDto;
48+
}
49+
50+
return $results;
51+
}
52+
}

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

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
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 EntityDataMapperData {
11+
private final String moduleName;
12+
private final String entityName;
13+
private final String namespace;
14+
private final String classFqn;
15+
private final String modelClassFqn;
16+
private final String dataModelClassFqn;
17+
18+
/**
19+
* Magento entity data mapper data constructor.
20+
*
21+
* @param moduleName String
22+
* @param entityName String
23+
* @param namespace String
24+
* @param modelClassFqn String
25+
* @param dataModelClassFqn String
26+
*/
27+
public EntityDataMapperData(
28+
final @NotNull String moduleName,
29+
final @NotNull String entityName,
30+
final @NotNull String namespace,
31+
final @NotNull String classFqn,
32+
final @NotNull String modelClassFqn,
33+
final @NotNull String dataModelClassFqn
34+
) {
35+
this.moduleName = moduleName;
36+
this.entityName = entityName;
37+
this.namespace = namespace;
38+
this.classFqn = classFqn;
39+
this.modelClassFqn = modelClassFqn;
40+
this.dataModelClassFqn = dataModelClassFqn;
41+
}
42+
43+
/**
44+
* Get module name.
45+
*
46+
* @return String
47+
*/
48+
public String getModuleName() {
49+
return moduleName;
50+
}
51+
52+
/**
53+
* Get entity name.
54+
*
55+
* @return String
56+
*/
57+
public String getEntityName() {
58+
return entityName;
59+
}
60+
61+
/**
62+
* Get namespace.
63+
*
64+
* @return String
65+
*/
66+
public String getNamespace() {
67+
return namespace;
68+
}
69+
70+
/**
71+
* Get class fqn.
72+
*
73+
* @return String
74+
*/
75+
public String getClassFqn() {
76+
return classFqn;
77+
}
78+
79+
/**
80+
* Get model class fqn.
81+
*
82+
* @return String
83+
*/
84+
public String getModelClassFqn() {
85+
return modelClassFqn;
86+
}
87+
88+
/**
89+
* Get data model class fqn.
90+
*
91+
* @return String
92+
*/
93+
public String getDataModelClassFqn() {
94+
return dataModelClassFqn;
95+
}
96+
}

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

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import com.magento.idea.magento2plugin.actions.generation.data.DataModelData;
1919
import com.magento.idea.magento2plugin.actions.generation.data.DataModelInterfaceData;
2020
import com.magento.idea.magento2plugin.actions.generation.data.DbSchemaXmlData;
21+
import com.magento.idea.magento2plugin.actions.generation.data.EntityDataMapperData;
2122
import com.magento.idea.magento2plugin.actions.generation.data.GetListQueryModelData;
2223
import com.magento.idea.magento2plugin.actions.generation.data.LayoutXmlData;
2324
import com.magento.idea.magento2plugin.actions.generation.data.MenuXmlData;
@@ -40,6 +41,7 @@
4041
import com.magento.idea.magento2plugin.actions.generation.generator.DataModelInterfaceGenerator;
4142
import com.magento.idea.magento2plugin.actions.generation.generator.DbSchemaWhitelistJsonGenerator;
4243
import com.magento.idea.magento2plugin.actions.generation.generator.DbSchemaXmlGenerator;
44+
import com.magento.idea.magento2plugin.actions.generation.generator.EntityDataMapperGenerator;
4345
import com.magento.idea.magento2plugin.actions.generation.generator.GetListQueryModelGenerator;
4446
import com.magento.idea.magento2plugin.actions.generation.generator.LayoutXmlGenerator;
4547
import com.magento.idea.magento2plugin.actions.generation.generator.MenuXmlGenerator;
@@ -58,6 +60,7 @@
5860
import com.magento.idea.magento2plugin.magento.files.ControllerBackendPhp;
5961
import com.magento.idea.magento2plugin.magento.files.DataModel;
6062
import com.magento.idea.magento2plugin.magento.files.DataModelInterface;
63+
import com.magento.idea.magento2plugin.magento.files.EntityDataMapperFile;
6164
import com.magento.idea.magento2plugin.magento.files.ModelPhp;
6265
import com.magento.idea.magento2plugin.magento.files.ModuleMenuXml;
6366
import com.magento.idea.magento2plugin.magento.files.ResourceModelPhp;
@@ -284,6 +287,7 @@ private void onOK() {
284287
generateRoutesXmlFile();
285288
generateViewControllerFile();
286289
generateSaveControllerFile();
290+
generateEntityDataMapperFile();
287291
generateModelGetListQueryFile();
288292
generateDataProviderFile();
289293
generateLayoutFile();
@@ -1043,6 +1047,41 @@ private void generateWhitelistJsonFile(final @NotNull DbSchemaXmlData dbSchemaXm
10431047
).generate(ACTION_NAME, false);
10441048
}
10451049

1050+
/**
1051+
* Generate entity data mapper type.
1052+
*/
1053+
private void generateEntityDataMapperFile() {
1054+
final EntityDataMapperFile entityDataMapperFile =
1055+
new EntityDataMapperFile(getEntityName());
1056+
1057+
final String namespace = entityDataMapperFile.getNamespace(getModuleName());
1058+
final String classFqn = entityDataMapperFile.getClassFqn(getModuleName());
1059+
1060+
final NamespaceBuilder modelNamespace = getModelNamespace();
1061+
final NamespaceBuilder dtoModelNamespace = getDataModelNamespace();
1062+
final NamespaceBuilder dtoInterfaceModelNamespace = getDataModelInterfaceNamespace();
1063+
1064+
final String dtoType;
1065+
1066+
if (createInterface.isSelected()) {
1067+
dtoType = dtoInterfaceModelNamespace.getClassFqn();
1068+
} else {
1069+
dtoType = dtoModelNamespace.getClassFqn();
1070+
}
1071+
1072+
new EntityDataMapperGenerator(
1073+
new EntityDataMapperData(
1074+
getModuleName(),
1075+
getEntityName(),
1076+
namespace,
1077+
classFqn,
1078+
modelNamespace.getClassFqn(),
1079+
dtoType
1080+
),
1081+
project
1082+
).generate(ACTION_NAME, false);
1083+
}
1084+
10461085
/**
10471086
* Run GetListQuery.php file generator.
10481087
*/
@@ -1066,8 +1105,10 @@ private void generateModelGetListQueryFile() {
10661105
* @return String
10671106
*/
10681107
private String getEntityDataMapperType() {
1069-
// TODO: implement with entity data mapper generation.
1070-
return "Test\\Test\\Mapper\\" + getEntityName() + "DataMapper";
1108+
final EntityDataMapperFile entityDataMapperFile =
1109+
new EntityDataMapperFile(getEntityName());
1110+
1111+
return entityDataMapperFile.getClassFqn(getModuleName());
10711112
}
10721113

10731114
/**

0 commit comments

Comments
 (0)