文档Commerce配置指南

配置类型

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 有经验的
  • 管理员
  • 开发人员

扩展配置类型

要扩展现有的配置类型，您只需在模块中创建配置文件即可。

例如，要添加事件观察者，您创建app/code/{VendorName}/{ModuleName}/etc/events.xml并声明一个新的观察者。

由于Commerce中存在事件配置类型，因此加载程序和events.xsd验证架构已存在且运行正常。

您的新events.xml自动从您的模块中收集，并与其他模块的其他events.xml文件合并。

创建配置类型

要创建配置类型，您必须至少添加：

  • 装载机
  • XSD验证架构
  • XML配置文件

例如，要为新的搜索服务器引入适配器，以便扩展能够配置如何在该服务器中索引其实体，请创建：

  • 装载机
  • XSD架构文件
  • 适当命名的配置文件。 例如，search.xml。 此文件将读取并根据您的架构进行验证。
  • 您工作所需的任何其他类。
INFO
如果新模块具有search.xml文件，则在加载时它们将与您的文件合并。

使用示例

要创建配置类型，请执行以下操作：

  1. 创建您的XSD文件。

  2. 创建XML文件。

  3. 在di.xml中定义配置对象。

    Magento_Sales模块的di.xml中的以下示例说明了配置对象的外观。

    code language-xml 
    <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <type name="Magento\Sales\Model\Order\Pdf\Config\Reader">
        <arguments>
            <argument name="fileName" xsi:type="string">pdf.xml</argument>
            <argument name="converter" xsi:type="object">Magento\Sales\Model\Order\Pdf\Config\Converter</argument>
            <argument name="schemaLocator" xsi:type="object">Magento\Sales\Model\Order\Pdf\Config\SchemaLocator</argument>
        </arguments>
    </type>

    <virtualType name="pdfConfigDataStorage" type="Magento\Framework\Config\Data">
        <arguments>
            <argument name="reader" xsi:type="object">Magento\Sales\Model\Order\Pdf\Config\Reader</argument>
            <argument name="cacheId" xsi:type="string">sales_pdf_config</argument>
        </arguments>
    </virtualType>

    <type name="Magento\Sales\Model\Order\Pdf\Config">
        <arguments>
            <argument name="dataStorage" xsi:type="object">pdfConfigDataStorage</argument>
        </arguments>
    </type>
</config>
    • 第一个类型节点设置Reader的文件名、关联的Converter和SchemaLocator类。
    • 然后，pdfConfigDataStorage虚拟类型节点将读取器类附加到Magento\Framework\Config\Data的实例。
    • 最后，最后一个类型节点将该配置数据虚拟类型附加到Magento\Sales\Model\Order\Pdf\Config类，该类用于实际读取这些pdf.xml文件中的值。

  4. 通过扩展Magento\Framework\Config\Reader\Filesystem类来定义读取器，并重写以下参数：

    code language-php 
    $_idAttributes // Array of node attribute IDs.

示例：

<?php
/**
 * Copyright Adobe
 * All Rights Reserved.
 */

namespace Vendor\ModuleName\Model\Config;

use Magento\Framework\Config\Reader\Filesystem;

class Reader extends Filesystem
{
    /**
     * List of identifier attributes for merging
     *
     * @var array
     */
    protected $_idAttributes = [
         '</path/to/node_in_your_xml_file>'        => '<identifierAttributeName>',
         '</path/to/other/node_in_your_xml_file>'  => '<identifierAttributeName>',
    ];
}
INFO
如果您希望创建自己的阅读器版本，可以通过实施\Magento\Framework\Config\ReaderInterface来实现。 查看Magento_Analytics配置读取器

定义读取器后，使用读取器收集、合并、验证配置文件并将其转换为内部数组表示形式。

验证配置类型

每个配置文件都根据特定于其配置类型的架构进行验证。 示例：在早期Commerce版本中配置在config.xml中的事件，现在在events.xml中配置。

可以在影响同一配置类型的多个文件的任意合并之前（可选）和之后验证配置文件。 除非单个文件和合并文件的验证规则相同，否则应提供两个用于验证配置文件的架构：

  • 用于验证个人的架构
  • 用于验证合并文件的架构

新配置文件必须附带XSD验证架构。 XML配置文件及其XSD验证文件必须具有相同的名称。

如果必须为单个XML文件使用两个XSD文件，则架构的名称应该可识别并与XML文件关联。
如果您有events.xml文件和第一个events.xsd文件，则合并的events.xml文件的XSD文件可以命名为events_merged.xsd。
要确保通过适当的XSD文件验证XML文件，必须将统一资源名称(URN)添加到XML文件的XSD文件中。 例如：

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager:etc/config.xsd">

IDE可以在运行时和开发过程中验证配置文件。

recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c