DeleteButton.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\Backend\Ui\Component\Control;

use Magento\Framework\App\RequestInterface;
use Magento\Framework\Escaper;
use Magento\Framework\UrlInterface;
use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;

class DeleteButton implements ButtonProviderInterface
{
    private $request;

    private $urlBuilder;

    private $escaper;

    private $confirmationMessage;

    private $idFieldName;

    private $deleteRoutePath;

    private $sortOrder;

    public function __construct(
        RequestInterface $request,
        UrlInterface $urlBuilder,
        Escaper $escaper,
        string $confirmationMessage,
        string $idFieldName,
        string $deleteRoutePath,
        int $sortOrder
    ) {
        $this->request = $request;
        $this->urlBuilder = $urlBuilder;
        $this->escaper = $escaper;
        $this->confirmationMessage = $confirmationMessage;
        $this->idFieldName = $idFieldName;
        $this->deleteRoutePath = $deleteRoutePath;
        $this->sortOrder = $sortOrder;
    }

    public function getButtonData()
    {
        $data = [];
        $fieldId = $this->escaper->escapeJs($this->escaper->escapeHtml($this->request->getParam($this->idFieldName)));
        if (null !== $fieldId) {
            $url = $this->urlBuilder->getUrl($this->deleteRoutePath);
            $escapedMessage = $this->escaper->escapeJs($this->escaper->escapeHtml($this->confirmationMessage));
            $data = [
                'label' => __('Delete'),
                'class' => 'delete',
                'on_click' => "deleteConfirm('{$escapedMessage}', '{$url}', {data:{{$this->idFieldName}:{$fieldId}}})",
                'sort_order' => $this->sortOrder,
            ];
        }
        return $data;
    }
}