Merge pull request #606 from bohdan-harniuk/entity-web-api-generation

Used a constant in all places where entity id was used as hardcoded value

Author: eduard13

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

@@ -56,9 +56,9 @@ class ${CLASS_NAME}
         try {
             /** @var ${MODEL} $model */
             $model = $this->modelFactory->create();
-            $this->resource->load($model, $entityId, '${ENTITY_ID}');
+            $this->resource->load($model, $entityId, ${ENTITY_ID_REFERENCE});
 
-            if (!$model->getData('${ENTITY_ID}')) {
+            if (!$model->getData(${ENTITY_ID_REFERENCE})) {
                 throw new ${NO_SUCH_ENTITY_EXCEPTION}(
                     __('Could not find ${ENTITY_NAME} with id: `%id`',
                         [

resources/fileTemplates/internal/Magento Entity Delete Controller Class.php.ft

@@ -47,7 +47,7 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS_POST}, ${IMPLEMEN
         /** @var ${RESULT_INTERFACE} $resultRedirect */
         $resultRedirect = $this->resultFactory->create(${RESULT_FACTORY}::TYPE_REDIRECT);
         $resultRedirect->setPath('*/*/');
-        $entityId = (int) $this->getRequest()->getParam('${ENTITY_ID}');
+        $entityId = (int) $this->getRequest()->getParam(${ENTITY_ID_REFERENCE});
 
         try {
             $this->deleteByIdCommand->execute($entityId);

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

@@ -77,7 +77,7 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS}
                 $this->dataPersistor->set('entity', $params);
 
                 return $resultRedirect->setPath('*/*/edit', [
-                '${ENTITY_ID}'=> $this->getRequest()->getParam('${ENTITY_ID}')
+                ${ENTITY_ID_REFERENCE} => $this->getRequest()->getParam(${ENTITY_ID_REFERENCE})
                 ]);
         }
 

resources/fileTemplates/internal/Magento Grid Ui Component Action Column Class.php.ft

@@ -59,12 +59,12 @@ class ${CLASS_NAME} extends ${PARENT_CLASS}
      */
     public function prepareDataSource(array $dataSource): array
     {
-    #set($entityIdAccessor = "['" + ${ENTITY_ID} + "']")
+    #set($entityIdAccessor = "[" + ${ENTITY_ID_REFERENCE} + "]")
         if (isset($dataSource['data']['items'])) {
             foreach ($dataSource['data']['items'] as &$item) {
                 if (isset($item$entityIdAccessor)) {
                     $entityName = static::ENTITY_NAME;
-                    $urlData = ['${ENTITY_ID}' => $item$entityIdAccessor];
+                    $urlData = [${ENTITY_ID_REFERENCE} => $item$entityIdAccessor];
 
                     $editUrl = $this->urlBuilder->getUrl(static::EDIT_URL_PATH, $urlData);
                     $deleteUrl = $this->urlBuilder->getUrl(static::DELETE_URL_PATH, $urlData);

resources/fileTemplates/internal/Magento PHP Form Generic Button Block Class.php.ft

@@ -40,7 +40,7 @@ class ${CLASS_NAME}
      */
     public function ${ENTITY_ID_GETTER}(): int
     {
-        return (int) $this->context->getRequest()->getParam('${ENTITY_ID}');
+        return (int) $this->context->getRequest()->getParam(${ENTITY_ID_REFERENCE});
     }
 
     /**

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

@@ -21,7 +21,11 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
      */
     protected function _construct()
     {
+#if (${ENTITY_ID_REFERENCE})
+        $this->_init('${DB_NAME}', ${ENTITY_ID_REFERENCE});
+#else
         $this->_init('${DB_NAME}', '${ENTITY_ID_COLUMN}');
+#end
         $this->_useIsObjectNew = true;
     }
 }

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

@@ -59,7 +59,7 @@ class ${CLASS_NAME}
             $model->addData($${DTO_PROPERTY}->getData());
             $model->setHasDataChanges(true);
 
-            if (!$model->getId()) {
+            if (!$model->getData(${ENTITY_ID_CONST})) {
                 $model->isObjectNew(true);
             }
             $this->resource->save($model);

resources/fileTemplates/internal/Magento UI Component Custom Data Provider Class.php.ft

@@ -87,7 +87,7 @@ class ${CLASS_NAME} extends ${EXTENDS}
             $result->getItems(),
             $result->getTotalCount(),
             $searchCriteria,
-            '#if(${ENTITY_ID})${ENTITY_ID}#{else}entity_id#end'
+            ${ENTITY_ID_REFERENCE}
         );
     }
 
@@ -104,14 +104,14 @@ class ${CLASS_NAME} extends ${EXTENDS}
         $this->loadedData = parent::getData();
         $itemsById = [];
 
-#set($entityId = "#if(${ENTITY_ID})${ENTITY_ID}#{else}entity_id#end")
-#set($entityIdAccessor = '[(int) $item[' + "'$entityId'" + ']]')
+#set($entityId = "${ENTITY_ID_REFERENCE}")
+#set($entityIdAccessor = '[(int) $item[' + "${ENTITY_ID_REFERENCE}" + ']]')
 #set($getIdAccessor = "[(int) $id]")
         foreach ($this->loadedData['items'] as $item) {
             $itemsById$entityIdAccessor = $item;
         }
 
-        if ($id = $this->request->getParam('$entityId', null)) {
+        if ($id = $this->request->getParam($entityId)) {
             $this->loadedData['entity'] = $itemsById$getIdAccessor;
         }
 

src/com/magento/idea/magento2plugin/actions/generation/context/EntityCreatorContext.java

@@ -0,0 +1,15 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation.context;
+
+import com.intellij.openapi.util.Key;
+import com.intellij.openapi.util.UserDataHolderBase;
+
+public class EntityCreatorContext extends UserDataHolderBase implements GenerationContext {
+
+    public static final Key<String> DTO_TYPE = Key.create("DTO_TYPE");
+    public static final Key<String> ENTITY_ID = Key.create("ENTITY_ID");
+}

src/com/magento/idea/magento2plugin/actions/generation/context/GenerationContext.java

@@ -0,0 +1,9 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation.context;
+
+public interface GenerationContext {
+}