project
menu_migration

Repository

# Export the Menu Export with ID my_export_id.
drush menu_migration:export my_export_id
# Export the Menu Export with ID my_export_id, and skip confirmation question.
drush menu_migration:export my_export_id -y
# Export the Menu Export with ID my_export_id.
drush mme my_export_id
# Export the Menu Export with ID my_export_id, and skip confirmation question.
drush mme my_export_id -y
# List all the available export entities
drush menu_migration:export-list
# List all the available export entities
drush mmel
# Export the main menu.
drush menu_migration:quick-export main
# Export the main menu and override the format (e.g. yaml).
drush menu_migration:quick-export main --format=yaml
# Export the main, footer, custom_menu menus.
drush menu_migration:quick-export main,footer,custom_menu
# Export the main menu, and skip confirmation question.
drush menu_migration:quick-export main -y
# Export the main, footer, custom_menu menus and skip the confirmation question.
drush menu_migration:quick-export main,footer,custom_menu -y
# Export the main menu.
drush mmqe main
# Export the main menu and override the format (e.g. yaml).
drush mmqe main --format=yaml
# Export the main, footer, custom_menu menus.
drush mmqe main,footer,custom_menu
# Export the main menu, and skip confirmation question.
drush mmqe main -y
# Export the main, footer, custom_menu menus and skip the confirmation question.
drush mmqe main,footer,custom_menu -y
# Import the Menu Import with ID my_import_id.
drush menu_migration:import my_import_id
# Import the Menu Import with ID my_import_id, and skip the confirmation question.
drush menu_migration:import my_import_id -y
# Import the Menu Import with ID my_import_id.
drush mmi my_import_id
# Import the Menu Import with ID my_import_id, and skip the confirmation question.
drush mmi my_import_id -y
# List all the available import entities
drush menu_migration:import-list
# List all the available import entities
drush mmil
# Import the main menu.
drush menu_migration:quick-import main
# Import the main menu and override the format (e.g. yaml).
drush menu_migration:quick-import main --format=yaml
# Import the main, footer, custom_menu menus.
drush menu_migration:quick-import main,footer,custom_menu
# Import the main menu, and skip confirmation question.
drush menu_migration:quick-import main -y
# Import the main, footer, custom_menu menus and skip the confirmation question.
drush menu_migration:quick-import main,footer,custom_menu -y
# Import the main menu.
drush mmqi main
# Import the main menu and override the format (e.g. yaml).
drush mmqi main --format=yaml
# Import the main, footer, custom_menu menus.
drush mmqi main,footer,custom_menu
# Import the main menu, and skip confirmation question.
drush mmqi main -y
# Import the main, footer, custom_menu menus and skip the confirmation question.
drush mmqi main,footer,custom_menu -y
<?php

namespace Drupal\mymodule\Plugin\menu_migration\ExportDestination;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\menu_migration\Attribute\MenuMigrationDestination;
use Drupal\menu_migration\Plugin\menu_migration\ExportDestination\ExportDestinationBase;

/**
 * Provides a MyDestination export destination.
 */
#[MenuMigrationDestination(
  id: 'mydestination',
  label: new TranslatableMarkup('My Destination'),
  multiple: FALSE, # Optional, defaults to TRUE
  cli: TRUE # Optional, defaults to FALSE
)]
class MyDestination extends ExportDestinationBase {

  /**
   * {@inheritdoc}
   */
  public function exportMenu(string $menuName) {
    // TODO: Implement the export logic and return a boolean.
    // If the export fails, and you wish to display e detailed error message
    // about what went wrong, you interrupt the process and do the following:
    throw new MenuMigrationException(sprintf('My error message with the "%s" argument.', $argument));
  }

  /**
   * {@inheritdoc}
   */
  public function getExportDescription() {
    $description = parent::getExportDescription();
    // The parent contains the general export description. You can add details
    // specific to your export plugin here.
    $description[] = $this->t('The menus will have something special.');
    return $description;
  }

}
/**
 * {@inheritdoc}
 */
public function configurationSummary() {
  return [
    $this->configuration['export_path'],
  ];
}
# This definition applies to ExportDestination plugins that don't allow multiple
# menus, and that don't have extra configurable fields other than menus and
# format.
menu_migration.destination_config.mydestination:
  type: source_destination_config_single
  label: 'My Destination'
menu_migration.destination_config.mydestination:
  type: source_destination_config_single
  label: 'My Destination'
  mapping:
    extra_config:
      type: string
      label: 'Extra Config'
<?php

namespace Drupal\mymodule\Plugin\menu_migration\Format;

use Drupal\Component\Serialization\Json;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\menu_migration\Attribute\MenuMigrationFormat;
use Drupal\menu_migration\Plugin\menu_migration\Format\FormatBase;

/**
 * Provides the myFormat import/export Format.
 */
#[MenuMigrationFormat(
  id: 'myformat',
  label: new TranslatableMarkup('My Format')
)]
class MyFormat extends FormatBase {

  /**
   * {@inheritdoc}
   */
  public function encode(array $menuTree) {
    // Here you encode your menu tree. Example with JSON.
    return Json::encode($menuTree);
  }

  /**
   * {@inheritdoc}
   */
  public function decode(mixed $menuTree) {
    // Here you decode your menu tree. Example with JSON.
    return Json::decode($menuTree);
  }

  /**
   * {@inheritdoc}
   */
  public function allowedExtensions() {
    // Here you add allowed file extensions for sources like file_upload. If
    // applicable?
    return ['json'];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultExtension() {
    // Here you add the default file extension for exports. If applicable?
    return 'json';
  }

  /**
   * {@inheritdoc}
   */
  public function mimeType() {
    // Here you add the default file mimetype for exports like download. If
    // applicable?
    return 'application/json';
  }

}
<?php

namespace Drupal\mymodule\Plugin\menu_migration\ImportSource;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\menu_migration\Attribute\MenuMigrationSource;
use Drupal\menu_migration\Plugin\menu_migration\ImportSource\ImportSourceBase;

/**
 * Provides a MySource import source.
 */
#[MenuMigrationSource(
  id: 'mysource',
  label: new TranslatableMarkup('My Source'),
  multiple: FALSE, # Optional, defaults to TRUE
  cli: TRUE # Optional, defaults to FALSE
)]
class MySource extends ImportSourceBase {

  /**
   * {@inheritdoc}
   */
  public function importMenu(string $menuName) {
    // TODO: Implement the import logic and return a boolean.
    // If the import fails, and you wish to display e detailed error message
    // about what went wrong, you interrupt the process and do the following:
    throw new MenuMigrationException(sprintf('My error message with the "%s" argument.', $argument));
  }

  /**
   * {@inheritdoc}
   */
  public function getImportDescription() {
    $description = parent::getImportDescription();
    // The parent contains the general import description. You can add details
    // specific to your export plugin here.
    $description[] = $this->t('The menus will have something special.');
    return $description;
  }

}
/**
 * {@inheritdoc}
 */
public function configurationSummary() {
  return [
    $this->configuration['import_path'],
  ];
}
# This definition applies to ImportSource plugins that don't allow multiple
# menus, and that don't have extra configurable fields other than menus and
# format.
menu_migration.source_config.mysource:
  type: source_destination_config_single
  label: 'My Source'
menu_migration.source_config.mysource:
  type: source_destination_config_single
  label: 'My Source'
  mapping:
    extra_config:
      type: string
      label: 'Extra Config'