class MenuLink
Drupal 6/7 menu link source from database.
Available configuration keys:
- menu_name: (optional) The menu name(s) to filter menu links from the source can be a string or an array. If not declared then menu links of all menus are retrieved.
Examples:
source:
  plugin: menu_link
  menu_name: main-menu
In this example menu links of main-menu are retrieved from the source database.
source:
  plugin: menu_link
  menu_name: [main-menu, navigation]
In this example menu links of main-menu and navigation menus are retrieved from the source database.
For additional configuration keys, refer to the parent classes:
Plugin annotation
@MigrateSource(
  id = "menu_link",
  source_module = "menu"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase- class \Drupal\menu_link_content\Plugin\migrate\source\MenuLink extends \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
 
 
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase
 
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
 
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of MenuLink
See also
\Drupal\migrate\Plugin\migrate\source\SqlBase
\Drupal\migrate\Plugin\migrate\source\SourcePluginBase
4 files declare their use of MenuLink
- MenuLinkLocalized.php in core/modules/ menu_link_content/ src/ Plugin/ migrate/ source/ d7/ MenuLinkLocalized.php 
- MenuLinkTest.php in core/modules/ menu_link_content/ tests/ src/ Kernel/ Plugin/ migrate/ source/ MenuLinkTest.php 
- MenuLinkTranslation.php in core/modules/ menu_link_content/ src/ Plugin/ migrate/ source/ d6/ MenuLinkTranslation.php 
- MenuLinkTranslation.php in core/modules/ menu_link_content/ src/ Plugin/ migrate/ source/ d7/ MenuLinkTranslation.php 
File
- 
              core/modules/ menu_link_content/ src/ Plugin/ migrate/ source/ MenuLink.php, line 48 
Namespace
Drupal\menu_link_content\Plugin\migrate\sourceView source
class MenuLink extends DrupalSqlBase {
  
  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this->select('menu_links', 'ml')
      ->fields('ml')
      ->condition('ml.menu_name', 'shortcut-set-%', 'NOT LIKE');
    $and = $query->andConditionGroup()
      ->condition('ml.module', 'menu')
      ->condition('ml.router_path', [
      'admin/build/menu-customize/%',
      'admin/structure/menu/manage/%',
    ], 'NOT IN');
    $condition = $query->orConditionGroup()
      ->condition('ml.customized', 1)
      ->condition($and);
    $query->condition($condition);
    if (isset($this->configuration['menu_name'])) {
      $query->condition('ml.menu_name', (array) $this->configuration['menu_name'], 'IN');
    }
    $query->leftJoin('menu_links', 'pl', '[ml].[plid] = [pl].[mlid]');
    $query->addField('pl', 'link_path', 'parent_link_path');
    $query->orderBy('ml.depth');
    $query->orderby('ml.mlid');
    return $query;
  }
  
  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [
      'menu_name' => $this->t("The menu name. All links with the same menu name (such as 'navigation') are part of the same menu."),
      'mlid' => $this->t('The menu link ID (mlid) is the integer primary key.'),
      'plid' => $this->t('The parent link ID (plid) is the mlid of the link above in the hierarchy, or zero if the link is at the top level in its menu.'),
      'link_path' => $this->t('The Drupal path or external path this link points to.'),
      'router_path' => $this->t('For links corresponding to a Drupal path (external = 0), this connects the link to a {menu_router}.path for joins.'),
      'link_title' => $this->t('The text displayed for the link, which may be modified by a title callback stored in {menu_router}.'),
      'options' => $this->t('A serialized array of options to set on the URL, such as a query string or HTML attributes.'),
      'module' => $this->t('The name of the module that generated this link.'),
      'hidden' => $this->t('A flag for whether the link should be rendered in menus. (1 = a disabled menu link that may be shown on admin screens, -1 = a menu callback, 0 = a normal, visible link)'),
      'external' => $this->t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'),
      'has_children' => $this->t('Flag indicating whether any links have this link as a parent (1 = children exist, 0 = no children).'),
      'expanded' => $this->t('Flag for whether this link should be rendered as expanded in menus - expanded links always have their child links displayed, instead of only when the link is in the active trail (1 = expanded, 0 = not expanded)'),
      'weight' => $this->t('Link weight among links in the same menu at the same depth.'),
      'depth' => $this->t('The depth relative to the top level. A link with plid == 0 will have depth == 1.'),
      'customized' => $this->t('A flag to indicate that the user has manually created or edited the link (1 = customized, 0 = not customized).'),
      'p1' => $this->t('The first mlid in the materialized path. If N = depth, then pN must equal the mlid. If depth > 1 then p(N-1) must equal the plid. All pX where X > depth must equal zero. The columns p1 .. p9 are also called the parents.'),
      'p2' => $this->t('The second mlid in the materialized path. See p1.'),
      'p3' => $this->t('The third mlid in the materialized path. See p1.'),
      'p4' => $this->t('The fourth mlid in the materialized path. See p1.'),
      'p5' => $this->t('The fifth mlid in the materialized path. See p1.'),
      'p6' => $this->t('The sixth mlid in the materialized path. See p1.'),
      'p7' => $this->t('The seventh mlid in the materialized path. See p1.'),
      'p8' => $this->t('The eighth mlid in the materialized path. See p1.'),
      'p9' => $this->t('The ninth mlid in the materialized path. See p1.'),
      'updated' => $this->t('Flag that indicates that this link was generated during the update from Drupal 5.'),
    ];
    // The database connection may not exist, for example, when building
    // the Migrate Message form.
    if ($source_database = $this->database) {
      $schema = $source_database->schema();
      if ($schema->fieldExists('menu_links', 'language')) {
        $fields['language'] = $this->t("Menu link language code.");
      }
      if ($schema->fieldExists('menu_links', 'i18n_tsid')) {
        $fields['i18n_tsid'] = $this->t("Translation set id.");
      }
    }
    return $fields;
  }
  
  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    // In Drupal 7 a language neutral menu_link can be translated. The menu
    // link is treated as if it is in the site default language. So, here
    // we look to see if this menu link has a translation and if so, the
    // language is changed to the default language. With the language set
    // the entity API will allow the saving of the translations.
    if ($row->hasSourceProperty('language') && $row->getSourceProperty('language') == 'und' && $this->hasTranslation($row->getSourceProperty('mlid'))) {
      $default_language = $this->variableGet('language_default', (object) [
        'language' => 'und',
      ]);
      $default_language = $default_language->language;
      $row->setSourceProperty('language', $default_language);
    }
    // If this menu link is part of translation set skip the translations. The
    // translations are migrated in d7_menu_link_localized.yml.
    $row->setSourceProperty('skip_translation', TRUE);
    if ($row->hasSourceProperty('i18n_tsid') && $row->getSourceProperty('i18n_tsid') != 0) {
      $source_mlid = $this->select('menu_links', 'ml')
        ->fields('ml', [
        'mlid',
      ])
        ->condition('i18n_tsid', $row->getSourceProperty('i18n_tsid'))
        ->orderBy('mlid')
        ->range(0, 1)
        ->execute()
        ->fetchField();
      if ($source_mlid !== $row->getSourceProperty('mlid')) {
        $row->setSourceProperty('skip_translation', FALSE);
      }
    }
    // In Drupal 6 the language for the menu is in the options array. Set
    // property 'is_localized' so that the process pipeline can determine if
    // the menu link is localize or not.
    $row->setSourceProperty('is_localized', NULL);
    $default_language = $this->variableGet('language_default', (object) [
      'language' => 'und',
    ]);
    $default_language = $default_language->language;
    $options = unserialize($row->getSourceProperty('options'));
    if (isset($options['langcode'])) {
      if ($options['langcode'] != $default_language) {
        $row->setSourceProperty('language', $options['langcode']);
        $row->setSourceProperty('is_localized', 'localized');
      }
    }
    $row->setSourceProperty('options', unserialize($row->getSourceProperty('options')));
    $row->setSourceProperty('enabled', !$row->getSourceProperty('hidden'));
    $description = $row->getSourceProperty('options/attributes/title');
    if ($description !== NULL) {
      $row->setSourceProperty('description', Unicode::truncate($description, 255));
    }
    return parent::prepareRow($row);
  }
  
  /**
   * Determines if this  menu_link has an i18n translation.
   *
   * @param string $mlid
   *   The menu id.
   *
   * @return bool
   *   True if the menu_link has an i18n translation.
   */
  public function hasTranslation($mlid) {
    if ($this->getDatabase()
      ->schema()
      ->tableExists('i18n_string')) {
      $results = $this->select('i18n_string', 'i18n')
        ->fields('i18n')
        ->condition('textgroup', 'menu')
        ->condition('type', 'item')
        ->condition('objectid', $mlid)
        ->execute()
        ->fetchAll();
      if ($results) {
        return TRUE;
      }
    }
    return FALSE;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['mlid']['type'] = 'integer';
    $ids['mlid']['alias'] = 'ml';
    return $ids;
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | |||
| DrupalSqlBase::$entityTypeManager | protected | property | The entity type manager. | |||
| DrupalSqlBase::$requirements | protected | property | If the source provider is missing. | |||
| DrupalSqlBase::$systemData | protected | property | The contents of the system table. | |||
| DrupalSqlBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | ||
| DrupalSqlBase::checkRequirements | public | function | Checks if requirements for this plugin are OK. | Overrides SqlBase::checkRequirements | 4 | |
| DrupalSqlBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | Overrides SqlBase::create | 2 | |
| DrupalSqlBase::getModuleSchemaVersion | protected | function | Retrieves a module schema_version from the source Drupal database. | |||
| DrupalSqlBase::getSourceModule | public | function | Gets the source module providing the source data. | Overrides SourcePluginBase::getSourceModule | ||
| DrupalSqlBase::getSystemData | public | function | Retrieves all system data information from the source Drupal database. | |||
| DrupalSqlBase::moduleExists | protected | function | Checks if a given module is enabled in the source Drupal database. | |||
| DrupalSqlBase::variableGet | protected | function | Reads a variable from a source Drupal database. | |||
| DrupalSqlBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides SqlBase::__construct | 6 | |
| MenuLink::fields | public | function | Returns available fields on the source. | Overrides MigrateSourceInterface::fields | 3 | |
| MenuLink::getIds | public | function | Defines the source fields uniquely identifying a source row. | Overrides MigrateSourceInterface::getIds | 3 | |
| MenuLink::hasTranslation | public | function | Determines if this menu_link has an i18n translation. | |||
| MenuLink::prepareRow | public | function | Adds additional data to the row. | Overrides SourcePluginBase::prepareRow | 3 | |
| MenuLink::query | public | function | Prepares query object to retrieve data from the source database. | Overrides SqlBase::query | 3 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| MigrateSourceInterface::NOT_COUNTABLE | constant | Indicates that the source is not countable. | ||||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | |||
| PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | |||
| PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | ||
| PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | |||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| SourcePluginBase::$cache | protected | property | The backend cache. | |||
| SourcePluginBase::$cacheCounts | protected | property | Whether this instance should cache the source count. | 1 | ||
| SourcePluginBase::$cacheKey | protected | property | Key to use for caching counts. | |||
| SourcePluginBase::$currentRow | protected | property | The current row from the query. | |||
| SourcePluginBase::$currentSourceIds | protected | property | The primary key of the current row. | |||
| SourcePluginBase::$highWaterProperty | protected | property | Information on the property used as the high-water mark. | |||
| SourcePluginBase::$highWaterStorage | protected | property | The key-value storage for the high-water value. | |||
| SourcePluginBase::$idMap | protected | property | The migration ID map. | |||
| SourcePluginBase::$iterator | protected | property | The iterator to iterate over the source rows. | |||
| SourcePluginBase::$mapRowAdded | protected | property | Flags whether source plugin will read the map row and add to data row. | |||
| SourcePluginBase::$migration | protected | property | The entity migration object. | |||
| SourcePluginBase::$moduleHandler | protected | property | The module handler service. | 2 | ||
| SourcePluginBase::$originalHighWater | protected | property | The high water mark at the beginning of the import operation. | |||
| SourcePluginBase::$skipCount | protected | property | Whether this instance should not attempt to count the source. | 1 | ||
| SourcePluginBase::$trackChanges | protected | property | Flags whether to track changes to incoming data. | 1 | ||
| SourcePluginBase::aboveHighWater | protected | function | Check if the incoming data is newer than what we've previously imported. | |||
| SourcePluginBase::count | public | function | Gets the source count. | 3 | ||
| SourcePluginBase::current | public | function | ||||
| SourcePluginBase::getCache | protected | function | Gets the cache object. | |||
| SourcePluginBase::getCurrentIds | public | function | Gets the currentSourceIds data member. | |||
| SourcePluginBase::getHighWater | protected | function | The current value of the high water mark. | |||
| SourcePluginBase::getHighWaterField | protected | function | Get the name of the field used as the high watermark. | |||
| SourcePluginBase::getHighWaterProperty | protected | function | Get information on the property used as the high watermark. | |||
| SourcePluginBase::getHighWaterStorage | protected | function | Get the high water storage object. | |||
| SourcePluginBase::getIterator | protected | function | Returns the iterator that will yield the row arrays to be processed. | |||
| SourcePluginBase::getModuleHandler | protected | function | Gets the module handler. | |||
| SourcePluginBase::key | public | function | Gets the iterator key. | |||
| SourcePluginBase::next | public | function | ||||
| SourcePluginBase::postRollback | public | function | Overrides RollbackAwareInterface::postRollback | |||
| SourcePluginBase::preRollback | public | function | Overrides RollbackAwareInterface::preRollback | |||
| SourcePluginBase::rowChanged | protected | function | Checks if the incoming row has changed since our last import. | |||
| SourcePluginBase::saveHighWater | protected | function | Save the new high water mark. | |||
| SourcePluginBase::valid | public | function | Checks whether the iterator is currently valid. | |||
| SqlBase::$batch | protected | property | The count of the number of batches run. | |||
| SqlBase::$batchSize | protected | property | Number of records to fetch from the database during each batch. | |||
| SqlBase::$database | protected | property | The database object. | 1 | ||
| SqlBase::$query | protected | property | The query string. | 81 | ||
| SqlBase::$state | protected | property | State service for retrieving database info. | |||
| SqlBase::doCount | protected | function | Gets the source count using countQuery(). | Overrides SourcePluginBase::doCount | 6 | |
| SqlBase::fetchNextBatch | protected | function | Prepares query for the next set of data from the source database. | |||
| SqlBase::fetchNextRow | protected | function | Position the iterator to the following row. | Overrides SourcePluginBase::fetchNextRow | ||
| SqlBase::getDatabase | public | function | Gets the database connection object. | 2 | ||
| SqlBase::initializeIterator | protected | function | Overrides SourcePluginBase::initializeIterator | 18 | ||
| SqlBase::mapJoinable | protected | function | Checks if we can join against the map table. | 1 | ||
| SqlBase::prepareQuery | protected | function | Adds tags and metadata to the query. | 1 | ||
| SqlBase::rewind | public | function | Overrides SourcePluginBase::rewind | |||
| SqlBase::select | protected | function | Wrapper for database select. | |||
| SqlBase::setUpDatabase | protected | function | Gets a connection to the referenced database. | |||
| SqlBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | |||
| SqlBase::__toString | public | function | Prints the query string when the object is used as a string. | Overrides MigrateSourceInterface::__toString | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
