Skip to content

Commit 690c7eb

Browse files
bohdan-harniukbohdan-harniuk
committed
Merge branch 'mainline-entity-manager' of github.com:magento/magento2-phpstorm-plugin into entity-manger-refactoring
2 parents 59015e0 + 17a6c03 commit 690c7eb

File tree

36 files changed

+1546
-8
lines changed

36 files changed

+1546
-8
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,9 @@
238238
<internalFileTemplate name="Magento PHP Form Generic Button Block Class"/>
239239
<internalFileTemplate name="Magento Entity New Action Controller Class"/>
240240
<internalFileTemplate name="Magento New Entity Layout XML"/>
241+
<internalFileTemplate name="Magento Delete Entity By Id Command"/>
242+
<internalFileTemplate name="Magento Entity Edit Action Controller Class"/>
243+
<internalFileTemplate name="Magento Entity Delete Controller Class"/>
241244

242245
<defaultLiveTemplates file="/liveTemplates/MagentoPWA.xml"/>
243246

‎resources/fileTemplates/internal/Magento Delete Entity By Id Command.php.ft

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
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+
* Delete ${ENTITY_NAME} by id Command.
13+
*/
14+
class ${CLASS_NAME}
15+
{
16+
/**
17+
* @var ${LOGGER}
18+
*/
19+
private $logger;
20+
21+
/**
22+
* @var ${MODEL_FACTORY}
23+
*/
24+
private $modelFactory;
25+
26+
/**
27+
* @var ${RESOURCE}
28+
*/
29+
private $resource;
30+
31+
/**
32+
* @param ${LOGGER} $logger
33+
* @param ${MODEL_FACTORY} $modelFactory
34+
* @param ${RESOURCE} $resource
35+
*/
36+
public function __construct(
37+
${LOGGER} $logger,
38+
${MODEL_FACTORY} $modelFactory,
39+
${RESOURCE} $resource
40+
) {
41+
$this->logger = $logger;
42+
$this->modelFactory = $modelFactory;
43+
$this->resource = $resource;
44+
}
45+
46+
/**
47+
* Delete ${ENTITY_NAME}.
48+
*
49+
* @param int $entityId
50+
*
51+
* @return void
52+
* @throws ${COULD_NOT_DELETE}|${NO_SUCH_ENTITY_EXCEPTION}
53+
*/
54+
public function execute(int $entityId)
55+
{
56+
try {
57+
/** @var ${MODEL} $model */
58+
$model = $this->modelFactory->create();
59+
$this->resource->load($model, $entityId, '${ENTITY_ID}');
60+
61+
if (!$model->getData('${ENTITY_ID}')) {
62+
throw new ${NO_SUCH_ENTITY_EXCEPTION}(
63+
__('Could not find ${ENTITY_NAME} with id: `%id`',
64+
[
65+
'id' => $entityId
66+
]
67+
)
68+
);
69+
}
70+
71+
$this->resource->delete($model);
72+
} catch (Exception $exception) {
73+
$this->logger->error(
74+
__('Could not delete ${ENTITY_NAME}. Original message: {message}'),
75+
[
76+
'message' => $exception->getMessage(),
77+
'exception' => $exception
78+
]
79+
);
80+
throw new ${COULD_NOT_DELETE}(__('Could not delete ${ENTITY_NAME}.'));
81+
}
82+
}
83+
}

‎resources/fileTemplates/internal/Magento Delete Entity By Id Command.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 Delete Controller Class.php.ft

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
* Delete ${ENTITY_NAME} controller.
13+
*/
14+
class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS_POST}, ${IMPLEMENTS_GET}
15+
{
16+
/**
17+
* Authorization level of a basic admin session.
18+
*
19+
* @see _isAllowed()
20+
*/
21+
const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
22+
23+
/**
24+
* @var ${DELETE_COMMAND}
25+
*/
26+
private $deleteByIdCommand;
27+
28+
/**
29+
* @param Context $context
30+
* @param DeleteByIdCommand $deleteByIdCommand
31+
*/
32+
public function __construct(
33+
${CONTEXT} $context,
34+
${DELETE_COMMAND} $deleteByIdCommand
35+
) {
36+
parent::__construct($context);
37+
$this->deleteByIdCommand = $deleteByIdCommand;
38+
}
39+
40+
/**
41+
* Delete ${ENTITY_NAME} action.
42+
*
43+
* @return ${RESULT_INTERFACE}
44+
*/
45+
public function execute()
46+
{
47+
/** @var ${RESULT_INTERFACE} $resultRedirect */
48+
$resultRedirect = $this->resultFactory->create(${RESULT_FACTORY}::TYPE_REDIRECT);
49+
$resultRedirect->setPath('*/*/');
50+
$entityId = (int) $this->getRequest()->getParam('${ENTITY_ID}');
51+
52+
try {
53+
$this->deleteByIdCommand->execute($entityId);
54+
$this->messageManager->addSuccessMessage(__('You have successfully deleted ${ENTITY_NAME} entity'));
55+
} catch (${COULD_NOT_DELETE} | ${NO_SUCH_ENTITY_EXCEPTION} $exception) {
56+
$this->messageManager->addErrorMessage($exception->getMessage());
57+
}
58+
59+
return $resultRedirect;
60+
}
61+
}

‎resources/fileTemplates/internal/Magento Entity Delete 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 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(

0 commit comments

Comments
 (0)