설명서Commerce구성 안내서

구성 유형

Last update: Mon Nov 25 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 판매 모듈의 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 [first year code created] 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 파일의 유효성을 검사하려면 XML 파일의 XSD 파일에 URN(Uniform Resource Name)을 추가해야 합니다. For example:

<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