Como posso adicionar um botão na seção de configuração de back-end do Magento 2 e chamar um método PHP simples quando clicamos no botão?
Essa chamada de método pode ser uma chamada AJAX.
Vamos descrever a solução usando o nosso módulo Outros também compraram como exemplo, onde MageWorx - um nome de fornecedor e AlsoBought - um nome de módulo:
Primeiro, você precisa adicionar seu botão como um campo no arquivo de configuração. (mageworx_collect como o exemplo):
app / code / MageWorx / AlsoBought / etc / 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>
Para desenhar esse botão de campo, o modelo front-end MageWorx\AlsoBought\Block\System\Config\Collect
será usado. Crie:
app / code / 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();
}
}
?>
Este é um modelo de campo típico. O botão é desenhado usando o getButtonHtml()
método Use o getAjaxUrl()
método para obter um URL.
Então, você precisará do modelo:
app / code / MageWorx / AlsoBought / view / adminhtml / templates / system / 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>
Você terá que reescrever a parte do código de acordo com suas necessidades, mas deixarei como exemplo. O método de solicitação do Ajax onCreate
e onSuccess
deve atender às suas necessidades. Além disso, você pode remover o <span class="collect-indicator" id="collect_span">
elemento Usamos para exibir o carregamento (botão giratório) e o resultado da ação.
Além disso, você precisará de um controlador, onde todas as operações necessárias serão processadas, e um roteador.
app / code / MageWorx / AlsoBought / etc / 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>
app / code / MageWorx / AlsoBought / Controller / 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 Este é o exemplo de trabalho do nosso módulo MageWorx Outros também compraram . Se você quiser estudá-lo, pode fazer o download gratuitamente.
Controller/Adminhtml/System/Config/Collection.php
?Você também pode verificá-lo em vendor / magento / module-customer / etc / adminhtml / system.xml para obter o botão. Abaixo do código, verifique-o no caminho acima. Crie frontend_model como este fornecedor / magento / module-customer / Block / Adminhtml / System / Config / Validatevat.php .
Caminho acima para sua referência. Agora crie apropriado para seu próprio módulo.
fonte
Para adicionar um botão na configuração do sistema e executar uma função personalizada, você precisa criar
frontend_model
para renderizar seu botão. No modelo defrontend_model
, você pode escrever sua lógica do ajax.Aqui está um exemplo:
Essa classe será responsável por renderizar o botão html.
getButtonHtml()
A função irá gerar o botão html.Aqui, temos o nosso
frontend_model
botão para renderizar. Agora, precisamos criar uma classe de controlador que manipule nossa solicitação de ajax.Temos uma função
getAjaxSyncUrl()
em nossafrontend_model
que retornará o URL deste controlador. Além disso, não é variável$_template
emfrontend_model
que mantém o caminho nosso arquivo de modelo para o nosso renderizador.Você pode ver no modelo, ao clicar no botão, ele acionará uma solicitação ajax para o controlador definido em
forntend_model
.Eu espero que isso ajude.
fonte
Você precisa definir o campo personalizado
frontend_model
para renderizar personalizado na configuração. Você pode obter ajuda neste link .fonte
Para criar um botão na seção de configuração de back-end, você precisa executar estas etapas:
Etapa 1: Adicionar um campo é um botão no arquivo
system.xml
como estes scripts:Etapa 2: botão Criar sistema
Block
:Criar arquivo
Namspace\Module\Block\System\Config\Button.php
:Etapa 3: criar arquivo
view/adminhtml/templates/system/config/button.phtml
:fonte