Как добавить кнопку в раздел конфигурации бэкэнда Magento 2 и вызвать простой метод PHP при нажатии кнопки?
Этот вызов метода может быть вызовом AJAX.
В качестве примера мы опишем решение, используя наш модуль Others Bought, где MageWorx - имя поставщика, а также AlwaysBought - имя модуля:
Во-первых, вам нужно добавить свою кнопку в качестве поля в файле конфигурации. (mageworx_collect в качестве примера):
Приложение / код / MageWorx / AlsoBought / и т.д. / adminhtml / System.Xml
<?xml version="1.0"?>
<!--
/**
* Copyright © 2016 MageWorx. All rights reserved.
* See LICENSE.txt for license details.
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<tab id="mageworx" sortOrder="2001">
<label>MageWorx</label>
</tab>
<section id="mageworx_alsobought" translate="label" type="text" sortOrder="100" showInDefault="1" showInWebsite="1" showInStore="0">
<label>Also Bought</label>
<tab>mageworx</tab>
<resource>MageWorx_AlsoBought::config</resource>
<group id="general" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
<label>General</label>
<field id="mageworx_collect" translate="label comment" type="button" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="0">
<frontend_model>MageWorx\AlsoBought\Block\System\Config\Collect</frontend_model>
<label>Collect all available data (in separate table)</label>
</field>
</group>
</section>
</system>
</config>
Для рисования этой кнопки-поля MageWorx\AlsoBought\Block\System\Config\Collect
будет использована модель внешнего интерфейса . Создать это:
Приложение / код / MageWorx / AlsoBought / Block / System / Config / Collect.php
<?php
/**
* Copyright © 2016 MageWorx. All rights reserved.
* See LICENSE.txt for license details.
*/
namespace MageWorx\AlsoBought\Block\System\Config;
use Magento\Backend\Block\Template\Context;
use Magento\Config\Block\System\Config\Form\Field;
use Magento\Framework\Data\Form\Element\AbstractElement;
class Collect extends Field
{
/**
* @var string
*/
protected $_template = 'MageWorx_AlsoBought::system/config/collect.phtml';
/**
* @param Context $context
* @param array $data
*/
public function __construct(
Context $context,
array $data = []
) {
parent::__construct($context, $data);
}
/**
* Remove scope label
*
* @param AbstractElement $element
* @return string
*/
public function render(AbstractElement $element)
{
$element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
return parent::render($element);
}
/**
* Return element html
*
* @param AbstractElement $element
* @return string
*/
protected function _getElementHtml(AbstractElement $element)
{
return $this->_toHtml();
}
/**
* Return ajax url for collect button
*
* @return string
*/
public function getAjaxUrl()
{
return $this->getUrl('mageworx_alsobought/system_config/collect');
}
/**
* Generate collect button html
*
* @return string
*/
public function getButtonHtml()
{
$button = $this->getLayout()->createBlock(
'Magento\Backend\Block\Widget\Button'
)->setData(
[
'id' => 'collect_button',
'label' => __('Collect Data'),
]
);
return $button->toHtml();
}
}
?>
Это типичная полевая модель. Кнопка нарисована с использованием getButtonHtml()
метода. Используйте getAjaxUrl()
метод, чтобы получить URL.
Затем вам понадобится шаблон:
Приложение / код / MageWorx / AlsoBought / просмотр / adminhtml / шаблоны / Система / Config / collect.phtml
<?php
/**
* Copyright © 2016 MageWorx. All rights reserved.
* See LICENSE.txt for license details.
*/
?>
<?php /* @var $block \MageWorx\AlsoBought\Block\System\Config\Collect */ ?>
<script>
require([
'jquery',
'prototype'
], function(jQuery){
var collectSpan = jQuery('#collect_span');
jQuery('#collect_button').click(function () {
var params = {};
new Ajax.Request('<?php echo $block->getAjaxUrl() ?>', {
parameters: params,
loaderArea: false,
asynchronous: true,
onCreate: function() {
collectSpan.find('.collected').hide();
collectSpan.find('.processing').show();
jQuery('#collect_message_span').text('');
},
onSuccess: function(response) {
collectSpan.find('.processing').hide();
var resultText = '';
if (response.status > 200) {
resultText = response.statusText;
} else {
resultText = 'Success';
collectSpan.find('.collected').show();
}
jQuery('#collect_message_span').text(resultText);
var json = response.responseJSON;
if (typeof json.time != 'undefined') {
jQuery('#row_mageworx_alsobought_general_collect_time').find('.value .time').text(json.time);
}
}
});
});
});
</script>
<?php echo $block->getButtonHtml() ?>
<span class="collect-indicator" id="collect_span">
<img class="processing" hidden="hidden" alt="Collecting" style="margin:0 5px" src="<?php echo $block->getViewFileUrl('images/process_spinner.gif') ?>"/>
<img class="collected" hidden="hidden" alt="Collected" style="margin:-3px 5px" src="<?php echo $block->getViewFileUrl('images/rule_component_apply.gif') ?>"/>
<span id="collect_message_span"></span>
</span>
Вам придется переписать часть кода в соответствии с вашими потребностями, но я оставлю это в качестве примера. Метод запроса AjaxonCreate
и onSuccess
должен соответствовать вашим потребностям. Также вы можете удалить <span class="collect-indicator" id="collect_span">
элемент. Мы используем его для отображения загрузки (счетчик) и результата действия.
Также вам понадобится контроллер, где будут обрабатываться все необходимые операции, и маршрутизатор.
Приложение / код / MageWorx / AlsoBought / и т.д. / adminhtml / routes.xml
<?xml version="1.0"?>
<!--
/**
* Copyright © 2016 MageWorx. All rights reserved.
* See LICENSE.txt for license details.
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
<router id="admin">
<route id="mageworx_alsobought" frontName="mageworx_alsobought">
<module name="MageWorx_AlsoBought" before="Magento_Backend" />
</route>
</router>
</config>
Приложение / код / MageWorx / AlsoBought / контроллер / Adminhtml / System / Config / Collect.php
<?php
/**
* Copyright © 2016 MageWorx. All rights reserved.
* See LICENSE.txt for license details.
*/
namespace MageWorx\AlsoBought\Controller\Adminhtml\System\Config;
use Magento\Backend\App\Action;
use Magento\Backend\App\Action\Context;
use Magento\Framework\Controller\Result\JsonFactory;
use MageWorx\AlsoBought\Helper\Data;
class Collect extends Action
{
protected $resultJsonFactory;
/**
* @var Data
*/
protected $helper;
/**
* @param Context $context
* @param JsonFactory $resultJsonFactory
* @param Data $helper
*/
public function __construct(
Context $context,
JsonFactory $resultJsonFactory,
Data $helper
)
{
$this->resultJsonFactory = $resultJsonFactory;
$this->helper = $helper;
parent::__construct($context);
}
/**
* Collect relations data
*
* @return \Magento\Framework\Controller\Result\Json
*/
public function execute()
{
try {
$this->_getSyncSingleton()->collectRelations();
} catch (\Exception $e) {
$this->_objectManager->get('Psr\Log\LoggerInterface')->critical($e);
}
$lastCollectTime = $this->helper->getLastCollectTime();
/** @var \Magento\Framework\Controller\Result\Json $result */
$result = $this->resultJsonFactory->create();
return $result->setData(['success' => true, 'time' => $lastCollectTime]);
}
/**
* Return product relation singleton
*
* @return \MageWorx\AlsoBought\Model\Relation
*/
protected function _getSyncSingleton()
{
return $this->_objectManager->get('MageWorx\AlsoBought\Model\Relation');
}
protected function _isAllowed()
{
return $this->_authorization->isAllowed('MageWorx_AlsoBought::config');
}
}
?>
PS Это рабочий пример из нашего модуля MageWorx Others Также Купленный . Если вы хотите изучить его, вы можете скачать его бесплатно.
Controller/Adminhtml/System/Config/Collection.php
?Вы также проверяете это в vendor / magento / module-customer / etc / adminhtml / system.xml для кнопки. Ниже кода проверьте его по указанному выше пути. Создайте frontend_model как этот поставщик / magento / module-customer / Block / Adminhtml / System / Config / Validatevat.php .
Выше путь для вашей справки. Теперь создайте подходящий для вашего собственного модуля.
источник
Чтобы добавить кнопку в конфигурацию системы и запустить пользовательскую функцию, необходимо создать
frontend_model
для отображения вашей кнопки. В шаблонеfrontend_model
вы можете написать свою логику.Вот пример:
Этот класс будет отвечать за рендеринг кнопки html.
getButtonHtml()
Функция сгенерирует кнопку HTML.Здесь у нас есть
frontend_model
кнопка рендеринга. Теперь нам нужно создать класс контроллера, который будет обрабатывать наш запрос ajax.У нас функции
getAjaxSyncUrl()
в нашей ,frontend_model
что будет возвращать URL этого контроллера. Кроме того , есть переменная$_template
вfrontend_model
том , что держит путь наш файл шаблона для нашего визуализатора.Вы можете видеть в шаблоне, по нажатию кнопки, это вызовет ajax-запрос к контроллеру, определенному в
forntend_model
.Надеюсь, это поможет.
источник
Вам необходимо определить
frontend_model
пользовательское поле для пользовательского рендера в конфигурации. Вы можете получить помощь по этой ссылке .источник
Чтобы создать кнопку в разделе конфигурации бэкэнда, вам необходимо выполнить следующие шаги:
Шаг 1: Добавить поле is button в файл,
system.xml
как эти сценарии:Шаг 2: Создать системную кнопку
Block
:Создать файл
Namspace\Module\Block\System\Config\Button.php
:Шаг 3: Создать файл
view/adminhtml/templates/system/config/button.phtml
:источник