Creación de un módulo
Un módulo es un elemento estructural de Commerce: módulos de la red troncal del sistema. You typically start a customization by building a module.
¿Para quién es este vídeo?
- Desarrolladores back-end
Pasos para añadir un módulo
- Cree la carpeta del módulo.
- Create the
etc/module.xmlfile. - Crear el archivo
registration.php. - Ejecute
bin/magento setup:upgradepara registrar e instalar el módulo. - Compruebe que el módulo funciona.
The module.xml file
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
<module name="Training_Sales">
<sequence>
<module name="Magento_Sales"/>
</sequence>
</module>
</config>
El archivo registration.php
<?php
use Magento\Framework\Component\ComponentRegistrar;
ComponentRegistrar::register(
ComponentRegistrar::MODULE,
'Training_Sales',
__DIR__);
Añadir un complemento
A continuación, agregue funcionalidad al módulo básico. Los complementos se utilizan como herramientas esenciales en el desarrollo de Adobe Commerce. This video and tutorial show you how to create a plugin.
Cosas que hay que recordar para complementos
- Usted declara todos los complementos en
di.xml. - You give each plugin a unique name.
- You can optionally set the
disabledandsortOrderattributes. - El ámbito del complemento se establece eligiendo la carpeta que contiene el archivo
di.xml. - You run plugins before, after, or around the target method call.
- Evite
aroundcomplementos. Le tientan, pero a menudo representan la opción incorrecta y causan problemas de rendimiento.
Ejemplos de código de complemento
El tutorial utiliza las siguientes clases XML y PHP para añadir un plugin a su primer módulo.
app/code/Training/Sales/etc/adminhtml/di.xml
<?xml version="1.0" ?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<!-- A Plugin that executes when the admin user places an order -->
<type name="Magento\Sales\Model\Order">
<plugin name="admin-training-sales-add-logging" type="Training\Sales\Plugin\AdminAddLoggingAfterOrderPlacePlugin" disabled="false" sortOrder="0"/>
</type>
</config>
app/code/Training/Sales/etc/frontend/di.xml
<?xml version="1.0" ?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<!-- A plugin that executes when a customer uses the LoginPost controller from the Luma frontend -->
<type name="Magento\Customer\Controller\Account\LoginPost">
<plugin name="training-customer-loginpost-plugin"
type="Training\Sales\Plugin\CustomerLoginPostPlugin" sortOrder="20"/>
</type>
</config>
app/code/Training/Sales/etc/webapi_rest/di.xml
<?xml version="1.0" ?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<!-- A plugin that executes when the REST API is used OR when the Luma frontend places an order -->
<type name="Magento\Sales\Model\Order">
<plugin name="rest-training-sales-add-logging" type="Training\Sales\Plugin\RestAddLoggingAfterOrderPlacePlugin"/>
</type>
</config>
app/code/Training/Sales/Plugin/AdminAddLoggingAfterOrderPlacePlugin.php
<?php
declare(strict_types=1);
namespace Training\Sales\Plugin;
use Magento\Sales\Model\Order;
use Psr\Log\LoggerInterface;
/**
*
*/
class AdminAddLoggingAfterOrderPlacePlugin
{
/**
* @var LoggerInterface
*/
private LoggerInterface $logger;
/**
* @param LoggerInterface $logger
*/
public function __construct(
LoggerInterface $logger
) {
$this->logger = $logger;
}
/**
* Add log after an order is placed
*
* @param Order $subject
* @param Order $result
* @return Order
*/
public function afterPlace(Order $subject, Order $result): Order
{
// Log this admin area order
$this->logger->notice('An ADMIN User placed an Order -
### app/code/Training/Sales/Plugin/CustomerLoginPostPlugin.php
```php
<?php
declare(strict_types=1);
namespace Training\Sales\Plugin;
use Psr\Log\LoggerInterface;
use Magento\Framework\App\RequestInterface;
/**
* Introduces Context information for ActionInterface of Customer Action
*/
class CustomerLoginPostPlugin
{
/**
* @var LoggerInterface
*/
private LoggerInterface $logger;
/**
* @var RequestInterface
*/
private RequestInterface $request;
/**
* @param LoggerInterface $logger
* @param RequestInterface $request
*/
public function __construct(LoggerInterface $logger, RequestInterface $request)
{
$this->logger = $logger;
$this->request = $request;
}
/**
* Simple example of a before Plugin on a public method in a Controller
*/
public function beforeExecute()
{
$login = $this->request->getParam('login');
$username = $login['username'];
$this->logger->notice( "Login Post controller was used for " . $username );
}
}
app/code/Training/Sales/Plugin/RestAddLoggingAfterOrderPlacePlugin.php
<?php
declare(strict_types=1);
namespace Training\Sales\Plugin;
use Magento\Sales\Model\Order;
use Psr\Log\LoggerInterface;
/**
*
*/
class RestAddLoggingAfterOrderPlacePlugin
{
/**
* @var LoggerInterface
*/
private LoggerInterface $logger;
/**
* @param LoggerInterface $logger
*/
public function __construct(
LoggerInterface $logger
) {
$this->logger = $logger;
}
/**
* Add log after an order is placed
*
* @param Order $subject
* @param Order $result
* @return Order
*/
public function afterPlace(Order $subject, Order $result): Order
{
// Log this customer driven order
$this->logger->notice('A Customer placed an Order for
## Recursos útiles
* [Guía de referencia del módulo](https://developer.adobe.com/commerce/php/module-reference/){target="_blank"}
* [Complementos](https://developer.adobe.com/commerce/php/development/components/plugins/){target="_blank"}
. $subject->getBaseTotalDue());
return $result;
}
}
app/code/Training/Sales/Plugin/CustomerLoginPostPlugin.php
CODE_BLOCK_PLACEHOLDER_6
app/code/Training/Sales/Plugin/RestAddLoggingAfterOrderPlacePlugin.php
CODE_BLOCK_PLACEHOLDER_7
Recursos útiles
. $subject->getBaseTotalDue());
return $result;
}
}
## Recursos útiles
* [Guía de referencia del módulo](https://developer.adobe.com/commerce/php/module-reference/){target="_blank"}
* [Complementos](https://developer.adobe.com/commerce/php/development/components/plugins/){target="_blank"}
. $subject->getBaseTotalDue());
return $result;
}
}
app/code/Training/Sales/Plugin/CustomerLoginPostPlugin.php
CODE_BLOCK_PLACEHOLDER_6
app/code/Training/Sales/Plugin/RestAddLoggingAfterOrderPlacePlugin.php
CODE_BLOCK_PLACEHOLDER_7
Recursos útiles
recommendation-more-help
commerce-learn-help-home