Allow button to be defined both via XML layout and custom PHP

Author: jissereitsma

Component/Grid/GridViewModel.php

@@ -8,6 +8,7 @@
 use Loki\AdminComponents\Grid\Filter\StaticFilterInterface;
 use Loki\AdminComponents\Grid\MassAction\MassActionFactory;
 use Loki\AdminComponents\Grid\State\FilterState;
+use Loki\AdminComponents\Ui\ButtonInterface;
 use Magento\Framework\Data\OptionSourceInterface;
 use Magento\Framework\DataObject;
 use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
@@ -270,31 +271,39 @@ public function getCellTemplates(): array
     }
 
     /**
-     * @return Button[]
+     * @return ButtonInterface[]
      */
     public function getButtons(): array
     {
-        $buttons = [];
         $buttonActions = (array)$this->getBlock()->getButtonActions();
-        if (!empty($buttonActions)) {
-            foreach ($buttonActions as $buttonAction) {
-                if (!is_array($buttonAction)) {
-                    continue;
-                }
+        if (empty($buttonActions)) {
+            return [];
+        }
 
-                if (!isset($buttonAction['method']) || !isset($buttonAction['label'])) {
-                    continue;
-                }
+        $buttons = [];
 
-                $buttons[] = $this->buttonFactory->create(
-                    (string)$buttonAction['method'],
-                    (string)$buttonAction['label'],
-                    isset($buttonAction['cssClass']) ? (string)$buttonAction['cssClass'] : '',
-                    isset($buttonAction['url']) ? (string)$buttonAction['url'] : '',
-                    isset($buttonAction['subButtons']) ? (string)$buttonAction['subButtons'] : [],
-                    isset($buttonAction['primary']) ? (bool)$buttonAction['primary'] : false,
-                );
+        foreach ($buttonActions as $buttonAction) {
+            if ($buttonAction instanceof ButtonInterface) {
+                $buttons[] = $buttonAction;
+                continue;
             }
+
+            if (!is_array($buttonAction)) {
+                continue;
+            }
+
+            if (!isset($buttonAction['method']) || !isset($buttonAction['label'])) {
+                continue;
+            }
+
+            $buttons[] = $this->buttonFactory->create(
+                (string)$buttonAction['method'],
+                (string)$buttonAction['label'],
+                isset($buttonAction['cssClass']) ? (string)$buttonAction['cssClass'] : '',
+                isset($buttonAction['url']) ? (string)$buttonAction['url'] : '',
+                isset($buttonAction['subButtons']) ? (string)$buttonAction['subButtons'] : [],
+                isset($buttonAction['primary']) ? (bool)$buttonAction['primary'] : false,
+            );
         }
 
         return $buttons;
@@ -317,6 +326,7 @@ public function getMassActions(): array
                     $massAction['label'],
                     $massAction['url'],
                     isset($massAction['url_parameters']) ? $massAction['url_parameters'] : [],
+                    $massAction,
                 );
             }
         }

Grid/MassAction/MassAction.php

@@ -11,6 +11,7 @@ public function __construct(
         protected string $label,
         protected string $url,
         protected array $urlParameters = [],
+        protected array $data = [],
     ) {
     }
 

Grid/MassAction/MassActionFactory.php

@@ -11,13 +11,17 @@ public function __construct(
     ) {
     }
 
-
-    public function create(string $label, string $url, array $urlParameters = []): MassActionInterface
-    {
+    public function create(
+        string $label,
+        string $url,
+        array $urlParameters = [],
+        array $data = []
+    ): MassActionInterface {
         return $this->objectManager->create(MassAction::class, [
             'label' => $label,
             'url' => $url,
             'urlParameters' => $urlParameters,
+            'data' => $data,
         ]);
     }
 }

Ui/Button.php

@@ -2,7 +2,7 @@
 
 namespace Loki\AdminComponents\Ui;
 
-class Button
+class Button implements ButtonInterface
 {
     public function __construct(
         private string $method,

Ui/ButtonInterface.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace Loki\AdminComponents\Ui;
+
+interface ButtonInterface
+{
+    public function getMethod(): string;
+
+    public function getLabel(): string;
+
+    public function getCssClass(): string;
+
+    /**
+     * @return Button[]
+     */
+    public function getSubButtons(): array;
+
+    public function getUrl(): string;
+}

view/adminhtml/templates/ui/button.phtml

@@ -1,15 +1,14 @@
 <?php
 declare(strict_types=1);
 
-/** @version 0.3.3 */
-
+use Loki\AdminComponents\Ui\ButtonInterface;
 use Magento\Framework\Escaper;
 use Magento\Framework\View\Element\Template;
-use Loki\AdminComponents\Ui\Button;
 
+/** @version 0.3.3 */
 /** @var Escaper $escaper */
 /** @var Template $block */
-/** @var Button $button */
+/** @var ButtonInterface $button */
 $button = $block->getButton();
 ?>
 <?php if ($button->getSubButtons()): ?>