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

Entity Web API generation

Author: eduard13

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

@@ -27,7 +27,7 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS_POST}, ${IMPLEMEN
 
     /**
      * @param Context $context
-     * @param DeleteByIdCommand $deleteByIdCommand
+     * @param ${DELETE_COMMAND} $deleteByIdCommand
      */
     public function __construct(
         ${CONTEXT} $context,

src/com/magento/idea/magento2plugin/actions/generation/data/DeleteEntityByIdCommandData.java

@@ -14,6 +14,7 @@ public class DeleteEntityByIdCommandData {
     private final String entityId;
     private final String modelName;
     private final String resourceModelName;
+    private final String aclResource;
 
     /**
      * Delete Command DTO Constructor.
@@ -23,19 +24,22 @@ public class DeleteEntityByIdCommandData {
      * @param entityId String
      * @param modelName String
      * @param resourceModelName String
+     * @param aclResource String
      */
     public DeleteEntityByIdCommandData(
             final @NotNull String moduleName,
             final @NotNull String entityName,
             final @NotNull String entityId,
             final @NotNull String modelName,
-            final @NotNull String resourceModelName
+            final @NotNull String resourceModelName,
+            final @NotNull String aclResource
     ) {
         this.moduleName = moduleName;
         this.entityName = entityName;
         this.entityId = entityId;
         this.modelName = modelName;
         this.resourceModelName = resourceModelName;
+        this.aclResource = aclResource;
     }
 
     /**
@@ -82,4 +86,13 @@ public String getModelName() {
     public String getResourceModelName() {
         return resourceModelName;
     }
+
+    /**
+     * Get ACL resource.
+     *
+     * @return String
+     */
+    public String getAclResource() {
+        return aclResource;
+    }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/DeleteEntityControllerFileData.java

@@ -13,6 +13,7 @@ public class DeleteEntityControllerFileData {
     private final String moduleName;
     private final String acl;
     private final String entityId;
+    private final boolean hasDeleteCommandInterface;
 
     /**
      * Controller Delete file constructor.
@@ -21,17 +22,20 @@ public class DeleteEntityControllerFileData {
      * @param moduleName String
      * @param acl String
      * @param entityId String
+     * @param hasDeleteCommandInterface boolean
      */
     public DeleteEntityControllerFileData(
             final @NotNull String entityName,
             final @NotNull String moduleName,
             final @NotNull String acl,
-            final @NotNull String entityId
+            final @NotNull String entityId,
+            final boolean hasDeleteCommandInterface
     ) {
         this.entityName = entityName;
         this.moduleName = moduleName;
         this.acl = acl;
         this.entityId = entityId;
+        this.hasDeleteCommandInterface = hasDeleteCommandInterface;
     }
 
     /**
@@ -69,4 +73,13 @@ public String getAcl() {
     public String getEntityId() {
         return entityId;
     }
+
+    /**
+     * Check if delete command has Web API interface.
+     *
+     * @return boolean
+     */
+    public boolean isHasDeleteCommandInterface() {
+        return hasDeleteCommandInterface;
+    }
 }

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

@@ -15,7 +15,7 @@ public class EntityDataMapperData {
     private final String modelName;
     private final String dtoName;
     private final String dtoInterfaceName;
-    private final boolean dtoWithInterface;
+    private final boolean hasDtoInterface;
 
     /**
      * Magento entity data mapper data constructor.
@@ -25,22 +25,22 @@ public class EntityDataMapperData {
      * @param modelName String
      * @param dtoName String
      * @param dtoInterfaceName String
-     * @param isDtoWithInterface boolean
+     * @param hasDtoInterface boolean
      */
     public EntityDataMapperData(
             final @NotNull String moduleName,
             final @NotNull String entityName,
             final @NotNull String modelName,
             final @NotNull String dtoName,
             final @NotNull String dtoInterfaceName,
-            final boolean isDtoWithInterface
+            final boolean hasDtoInterface
     ) {
         this.moduleName = moduleName;
         this.entityName = entityName;
         this.modelName = modelName;
         this.dtoName = dtoName;
         this.dtoInterfaceName = dtoInterfaceName;
-        this.dtoWithInterface = isDtoWithInterface;
+        this.hasDtoInterface = hasDtoInterface;
     }
 
     /**
@@ -93,7 +93,7 @@ public String getDtoInterfaceName() {
      *
      * @return boolean
      */
-    public boolean isDtoWithInterface() {
-        return dtoWithInterface;
+    public boolean isHasDtoInterface() {
+        return hasDtoInterface;
     }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/GetListQueryModelData.java

@@ -13,6 +13,7 @@ public class GetListQueryModelData {
     private final String entityName;
     private final String modelName;
     private final String collectionName;
+    private final String aclResource;
 
     /**
      * Query Model DTO Constructor.
@@ -21,17 +22,20 @@ public class GetListQueryModelData {
      * @param entityName String
      * @param modelName String
      * @param collectionName String
+     * @param aclResource String
      */
     public GetListQueryModelData(
             final @NotNull String moduleName,
             final @NotNull String entityName,
             final @NotNull String modelName,
-            final @NotNull String collectionName
+            final @NotNull String collectionName,
+            final @NotNull String aclResource
     ) {
         this.moduleName = moduleName;
         this.entityName = entityName;
         this.modelName = modelName;
         this.collectionName = collectionName;
+        this.aclResource = aclResource;
     }
 
     /**
@@ -69,4 +73,13 @@ public String getModelName() {
     public String getCollectionName() {
         return collectionName;
     }
+
+    /**
+     * Get entity acl resource.
+     *
+     * @return String
+     */
+    public String getAclResource() {
+        return aclResource;
+    }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/SaveEntityCommandData.java

@@ -16,6 +16,7 @@ public class SaveEntityCommandData {
     private final String dtoName;
     private final String dtoInterfaceName;
     private final boolean dtoWithInterface;
+    private final String aclResource;
 
     /**
      * Save Command DTO Constructor.
@@ -27,6 +28,7 @@ public class SaveEntityCommandData {
      * @param dtoName String
      * @param dtoInterfaceName String
      * @param isDtoWithInterface boolean
+     * @param aclResource String
      */
     public SaveEntityCommandData(
             final @NotNull String moduleName,
@@ -35,7 +37,8 @@ public SaveEntityCommandData(
             final @NotNull String resourceModelName,
             final @NotNull String dtoName,
             final @NotNull String dtoInterfaceName,
-            final boolean isDtoWithInterface
+            final boolean isDtoWithInterface,
+            final @NotNull String aclResource
     ) {
         this.moduleName = moduleName;
         this.entityName = entityName;
@@ -44,6 +47,7 @@ public SaveEntityCommandData(
         this.dtoName = dtoName;
         this.dtoInterfaceName = dtoInterfaceName;
         this.dtoWithInterface = isDtoWithInterface;
+        this.aclResource = aclResource;
     }
 
     /**
@@ -108,4 +112,13 @@ public String getDtoInterfaceName() {
     public boolean isDtoWithInterface() {
         return dtoWithInterface;
     }
+
+    /**
+     * Get ACL resource.
+     *
+     * @return String
+     */
+    public String getAclResource() {
+        return aclResource;
+    }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/SaveEntityControllerFileData.java

@@ -15,7 +15,8 @@ public class SaveEntityControllerFileData {
     private final String entityId;
     private final String dtoName;
     private final String dtoInterfaceName;
-    private final boolean dtoWithInterface;
+    private final boolean hasDtoInterface;
+    private final boolean hasSaveCommandInterface;
 
     /**
      * Controller save file constructor.
@@ -26,7 +27,8 @@ public class SaveEntityControllerFileData {
      * @param entityId String
      * @param dtoName String
      * @param dtoInterfaceName String
-     * @param isDtoWithInterface boolean
+     * @param hasDtoInterface boolean
+     * @param hasSaveCommandInterface boolean
      */
     public SaveEntityControllerFileData(
             final @NotNull String entityName,
@@ -35,15 +37,17 @@ public SaveEntityControllerFileData(
             final @NotNull String entityId,
             final @NotNull String dtoName,
             final @NotNull String dtoInterfaceName,
-            final boolean isDtoWithInterface
+            final boolean hasDtoInterface,
+            final boolean hasSaveCommandInterface
     ) {
         this.entityName = entityName;
         this.moduleName = moduleName;
         this.acl = acl;
         this.entityId = entityId;
         this.dtoName = dtoName;
         this.dtoInterfaceName = dtoInterfaceName;
-        this.dtoWithInterface = isDtoWithInterface;
+        this.hasDtoInterface = hasDtoInterface;
+        this.hasSaveCommandInterface = hasSaveCommandInterface;
     }
 
     /**
@@ -105,7 +109,16 @@ public String getDtoInterfaceName() {
      *
      * @return boolean
      */
-    public boolean isDtoWithInterface() {
-        return dtoWithInterface;
+    public boolean isHasDtoInterface() {
+        return hasDtoInterface;
+    }
+
+    /**
+     * Check if save command has interface.
+     *
+     * @return boolean
+     */
+    public boolean isHasSaveCommandInterface() {
+        return hasSaveCommandInterface;
     }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/UiComponentDataProviderData.java

@@ -11,6 +11,7 @@ public class UiComponentDataProviderData {
     private final String path;
     private final String entityName;
     private final String entityIdFieldName;
+    private final boolean hasQueryInterface;
 
     /**
      * UiComponentGridDataProviderData constructor.
@@ -22,7 +23,7 @@ public UiComponentDataProviderData(
             final String name,
             final String path
     ) {
-        this(name, path, null, null);
+        this(name, path, null, null, false);
     }
 
     /**
@@ -32,17 +33,20 @@ public UiComponentDataProviderData(
      * @param path String
      * @param entityName String
      * @param entityIdFieldName String
+     * @param hasQueryInterface boolean
      */
     public UiComponentDataProviderData(
             final String name,
             final String path,
             final String entityName,
-            final String entityIdFieldName
+            final String entityIdFieldName,
+            final boolean hasQueryInterface
     ) {
         this.name = name;
         this.path = path;
         this.entityName = entityName;
         this.entityIdFieldName = entityIdFieldName;
+        this.hasQueryInterface = hasQueryInterface;
     }
 
     /**
@@ -80,4 +84,13 @@ public String getEntityName() {
     public String getEntityIdFieldName() {
         return entityIdFieldName;
     }
+
+    /**
+     * Check if query service has Web API interface.
+     *
+     * @return boolean
+     */
+    public boolean isHasQueryInterface() {
+        return hasQueryInterface;
+    }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/converter/newentitydialog/DataProviderDtoConverter.java

@@ -30,7 +30,8 @@ public DataProviderDtoConverter(
                 newEntityDialogData.getEntityName().concat("DataProvider"),
                 UiComponentDataProviderFile.DIRECTORY,
                 newEntityDialogData.getEntityName(),
-                newEntityDialogData.getIdFieldName()
+                newEntityDialogData.getIdFieldName(),
+                newEntityDialogData.hasWebApi()
         );
     }
 }

src/com/magento/idea/magento2plugin/actions/generation/data/converter/newentitydialog/DeleteEntityByIdCommandDtoConverter.java

@@ -29,7 +29,8 @@ public DeleteEntityByIdCommandDtoConverter(
                 newEntityDialogData.getEntityName(),
                 newEntityDialogData.getIdFieldName(),
                 newEntityDialogData.getEntityName().concat("Model"),
-                newEntityDialogData.getEntityName().concat("Resource")
+                newEntityDialogData.getEntityName().concat("Resource"),
+                newEntityDialogData.getAclId()
         );
     }
 }