Implement form with save and delete functionality for the Asynchronous Event Subscriber entity

Author: avstudnitz

Api/Data/AsyncEventInterface.php

@@ -12,8 +12,6 @@ class Back extends GenericButton implements ButtonProviderInterface
 {
     /**
      * Retrieve Back To Grid button settings.
-     *
-     * @return array
      */
     public function getButtonData(): array
     {

Block/Form/AsyncEvent/Back.php

@@ -13,8 +13,6 @@ class Delete extends GenericButton implements ButtonProviderInterface
 {
     /**
      * Retrieve Delete button settings.
-     *
-     * @return array
      */
     public function getButtonData(): array
     {
@@ -25,11 +23,12 @@ public function getButtonData(): array
         return $this->wrapButtonSettings(
             __('Delete')->getText(),
             'delete',
-            sprintf("deleteConfirm('%s', '%s')",
-                __('Are you sure you want to delete this asyncevent?'),
+            sprintf(
+                "deleteConfirm('%s', '%s')",
+                __('Are you sure you want to delete this Asynchronous Event Subscriber?'),
                 $this->getUrl(
                     '*/*/delete',
-                    [AsyncEventInterface::SUBSCRIPTION_ID => $this->getSubscriptionId()]
+                    ['subscription_id' => $this->getSubscriptionId()]
                 )
             ),
             [],

Block/Form/AsyncEvent/Delete.php

@@ -3,65 +3,39 @@
 
 namespace MageOS\AsyncEventsAdminUi\Block\Form\AsyncEvent;
 
-use MageOS\AsyncEventsAdminUi\Api\Data\AsyncEventInterface;
 use Magento\Backend\Block\Widget\Context;
 use Magento\Framework\UrlInterface;
 
 /**
- * Generic (form) button for AsyncEvent entity.
+ * Generic (form) button for Asynchronous Event Subscriber entity.
  */
 class GenericButton
 {
-    /**
-     * @var Context
-     */
     private Context $context;
-
-    /**
-     * @var UrlInterface
-     */
     private UrlInterface $urlBuilder;
 
-    /**
-     * @param Context $context
-     */
     public function __construct(
         Context $context
-    )
-    {
+    ) {
         $this->context = $context;
         $this->urlBuilder = $context->getUrlBuilder();
     }
 
-    /**
-     * Get AsyncEvent entity id.
-     *
-     * @return int
-     */
     public function getSubscriptionId(): int
     {
-        return (int)$this->context->getRequest()->getParam(AsyncEventInterface::SUBSCRIPTION_ID);
+        return (int)$this->context->getRequest()->getParam('subscription_id');
     }
 
     /**
-     * Wrap button specific options to settings array.
-     *
-     * @param string $label
-     * @param string $class
-     * @param string $onclick
-     * @param array $dataAttribute
-     * @param int $sortOrder
-     *
-     * @return array
+     * Wrap button specific options to settings array
      */
     protected function wrapButtonSettings(
         string $label,
         string $class,
         string $onclick = '',
         array  $dataAttribute = [],
         int    $sortOrder = 0
-    ): array
-    {
+    ): array {
         return [
             'label' => $label,
             'on_click' => $onclick,
@@ -71,14 +45,6 @@ protected function wrapButtonSettings(
         ];
     }
 
-    /**
-     * Get url.
-     *
-     * @param string $route
-     * @param array $params
-     *
-     * @return string
-     */
     protected function getUrl(string $route, array $params = []): string
     {
         return $this->urlBuilder->getUrl($route, $params);

Block/Form/AsyncEvent/GenericButton.php

@@ -12,8 +12,6 @@ class Save extends GenericButton implements ButtonProviderInterface
 {
     /**
      * Retrieve Save button settings.
-     *
-     * @return array
      */
     public function getButtonData(): array
     {

Block/Form/AsyncEvent/Save.php

@@ -4,10 +4,9 @@
 namespace MageOS\AsyncEventsAdminUi\Command\AsyncEvent;
 
 use Exception;
-use MageOS\AsyncEventsAdminUi\Api\Data\AsyncEventInterface;
-use MageOS\AsyncEventsAdminUi\Model\AsyncEventModel;
-use MageOS\AsyncEventsAdminUi\Model\AsyncEventModelFactory;
-use MageOS\AsyncEventsAdminUi\Model\ResourceModel\AsyncEventResource;
+use MageOS\AsyncEvents\Model\AsyncEvent as AsyncEventModel;
+use MageOS\AsyncEvents\Model\AsyncEventFactory as AsyncEventModelFactory;
+use MageOS\AsyncEvents\Model\ResourceModel\AsyncEvent as AsyncEventResource;
 use Magento\Framework\Exception\CouldNotDeleteException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Psr\Log\LoggerInterface;
@@ -17,32 +16,15 @@
  */
 class DeleteByIdCommand
 {
-    /**
-     * @var LoggerInterface
-     */
     private LoggerInterface $logger;
-
-    /**
-     * @var AsyncEventModelFactory
-     */
     private AsyncEventModelFactory $modelFactory;
-
-    /**
-     * @var AsyncEventResource
-     */
     private AsyncEventResource $resource;
 
-    /**
-     * @param LoggerInterface $logger
-     * @param AsyncEventModelFactory $modelFactory
-     * @param AsyncEventResource $resource
-     */
     public function __construct(
         LoggerInterface        $logger,
         AsyncEventModelFactory $modelFactory,
         AsyncEventResource     $resource
-    )
-    {
+    ) {
         $this->logger = $logger;
         $this->modelFactory = $modelFactory;
         $this->resource = $resource;
@@ -51,23 +33,21 @@ public function __construct(
     /**
      * Delete AsyncEvent.
      *
-     * @param int $entityId
-     *
-     * @return void
      * @throws CouldNotDeleteException
      */
     public function execute(int $entityId): void
     {
         try {
             /** @var AsyncEventModel $model */
             $model = $this->modelFactory->create();
-            $this->resource->load($model, $entityId, AsyncEventInterface::SUBSCRIPTION_ID);
+            $this->resource->load($model, $entityId);
 
-            if (!$model->getData(AsyncEventInterface::SUBSCRIPTION_ID)) {
+            if (!$model->getSubscriptionId()) {
                 throw new NoSuchEntityException(
-                    __('Could not find AsyncEvent with id: `%id`',
+                    __(
+                        'Could not find Asynchronous Event Subscriber with id: `%subscription_id`',
                         [
-                            'id' => $entityId
+                            'subscription_id' => $entityId
                         ]
                     )
                 );
@@ -76,13 +56,13 @@ public function execute(int $entityId): void
             $this->resource->delete($model);
         } catch (Exception $exception) {
             $this->logger->error(
-                __('Could not delete AsyncEvent. Original message: {message}'),
+                __('Could not delete Asynchronous Event Subscriber. Original message: {message}'),
                 [
                     'message' => $exception->getMessage(),
                     'exception' => $exception
                 ]
             );
-            throw new CouldNotDeleteException(__('Could not delete AsyncEvent.'));
+            throw new CouldNotDeleteException(__('Could not delete Asynchronous Event Subscriber.'));
         }
     }
 }