Включите конфигурацию по умолчанию в ваш модуль Drupal 8

Основная тема: конфигурация по умолчанию

Обзор

В Drupal 7 для конфигурации по умолчанию для таких модулей, как типы контента, конфигурация полей, представления и т. д., Требуется специальный PHP-код для установки и обновления. В Drupal 8 они хранятся вместе с системой конфигурации в текстовых файлах YAML.

Например, система управления конфигурацией заботится о создании и управлении типами контента. Вы можете отправить тип содержимого вместе с вашим модулем, создав файл конфигурации с надлежащим именем и структурой.

Пример

Создайте файл с именем node.type.example_mytype.yml и поместите его в каталог вашего модуля в подкаталоге config/install. Например, этот файл может быть в /modules/example/config/install/node.type.example_mytype.yml, если модуль находится в /modules/example.

Пожалуйста, соблюдайте соглашение об именах, согласно которому вы ставите префикс вашего типа контента перед именем вашего модуля, за которым следует подчеркивание, чтобы избежать конфликтов с другими файлами конфигурации.

Затем вы можете поместить следующий код в этот файл:

type: example_mytype
name: Example
description: 'Use <em>example</em> content to get to Drupal 8 development better.'
help: ''
new_revision: false
display_submitted: true
preview_mode: 1
status: true
langcode: en

См. node.type.article.yml для живого примера.

Вы можете включить конфигурацию по умолчанию для других вещей, таких как размещение блоков, представления, текстовые форматы, конфигурация редактора, роли пользователей и т. д. таким же образом.

Вы можете установить значения по умолчанию для полей формы, таких как автор узла.

Если вы установили модуль до добавления этого типа контента, вам нужно будет удалить и установить его снова, чтобы конфигурация вступила в силу.

Экспорт конфигурации

Вы можете создать эти файлы, экспортировав конфигурацию в Конфигурация> Разработка> Синхронизация конфигурации. Вы можете использовать функцию «Единый импорт/экспорт» для экспорта одного фрагмента конфигурации, и в этом случае вам предоставляется текстовая область, содержащая код для копирования / вставки в файл конфигурации. Или вы можете выполнить «Полный экспорт», который позволит вам загрузить файл tar.gz, содержащий все файлы конфигурации в одной папке.

При использовании экспортированной конфигурации важно удалить UUID из конфигурации. Каждый фрагмент конфигурации уникально идентифицируется этим идентификатором. Если вы включите этот UUID в свой модуль, идентификатор будет одинаковым для всех сайтов, которые используют ваш модуль, поэтому он больше не будет уникальным. Если вы просто удалите эту строку из конфигурации, Drupal будет генерировать новые UUID, когда ваш модуль включен, гарантируя уникальность.

uuid: 626187e6-2176-4a73-8900-c0912580e4a1 < < Remove this!
langcode: en
status: true

Консоль Drupal

Утилита Drupal Console предоставляет следующую команду:

• config:export:content:type

Он будет выполнять следующие задачи:

• Экспортируйте все файлы конфигурации, связанные с указанным типом содержимого (включая его файлы конфигурации поля).
• Поместите его в каталог конфигурации нужного модуля.

Таким образом, это экономит много работы, требуемой вышеописанным ручным процессом.

Смотрите также

• YAML
• Система конфигурации Drupal 8