www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/menu_link_content/src/Plugin/migrate/source/MenuLink.php

   1 <?php
   2
   3 namespace Drupal\menu_link_content\Plugin\migrate\source;
   4
   5 use Drupal\Component\Utility\Unicode;
   6 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
   7 use Drupal\migrate\Row;
   8
   9 /**
  10  * Drupal menu link source from database.
  11  *
  12  * @MigrateSource(
  13  *   id = "menu_link",
  14  *   source_module = "menu"
  15  * )
  16  */
  17 class MenuLink extends DrupalSqlBase {
  18
  19   /**
  20    * {@inheritdoc}
  21    */
  22   public function query() {
  23     $query = $this->select('menu_links', 'ml')
  24       ->fields('ml');
  25     $and = $query->andConditionGroup()
  26       ->condition('ml.module', 'menu')
  27       ->condition('ml.router_path', ['admin/build/menu-customize/%', 'admin/structure/menu/manage/%'], 'NOT IN');
  28     $condition = $query->orConditionGroup()
  29       ->condition('ml.customized', 1)
  30       ->condition($and);
  31     $query->condition($condition);
  32     $query->leftJoin('menu_links', 'pl', 'ml.plid = pl.mlid');
  33     $query->addField('pl', 'link_path', 'parent_link_path');
  34     $query->orderBy('ml.depth');
  35     $query->orderby('ml.mlid');
  36     return $query;
  37   }
  38
  39   /**
  40    * {@inheritdoc}
  41    */
  42   public function fields() {
  43     return [
  44       'menu_name' => t("The menu name. All links with the same menu name (such as 'navigation') are part of the same menu."),
  45       'mlid' => t('The menu link ID (mlid) is the integer primary key.'),
  46       'plid' => 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.'),
  47       'link_path' => t('The Drupal path or external path this link points to.'),
  48       'router_path' => t('For links corresponding to a Drupal path (external = 0), this connects the link to a {menu_router}.path for joins.'),
  49       'link_title' => t('The text displayed for the link, which may be modified by a title callback stored in {menu_router}.'),
  50       'options' => t('A serialized array of options to set on the URL, such as a query string or HTML attributes.'),
  51       'module' => t('The name of the module that generated this link.'),
  52       'hidden' => t('A flag for whether the link should be rendered in menus. (1 = a disabled menu item that may be shown on admin screens, -1 = a menu callback, 0 = a normal, visible link)'),
  53       'external' => t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'),
  54       'has_children' => t('Flag indicating whether any links have this link as a parent (1 = children exist, 0 = no children).'),
  55       'expanded' => 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)'),
  56       'weight' => t('Link weight among links in the same menu at the same depth.'),
  57       'depth' => t('The depth relative to the top level. A link with plid == 0 will have depth == 1.'),
  58       'customized' => t('A flag to indicate that the user has manually created or edited the link (1 = customized, 0 = not customized).'),
  59       'p1' => 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.'),
  60       'p2' => t('The second mlid in the materialized path. See p1.'),
  61       'p3' => t('The third mlid in the materialized path. See p1.'),
  62       'p4' => t('The fourth mlid in the materialized path. See p1.'),
  63       'p5' => t('The fifth mlid in the materialized path. See p1.'),
  64       'p6' => t('The sixth mlid in the materialized path. See p1.'),
  65       'p7' => t('The seventh mlid in the materialized path. See p1.'),
  66       'p8' => t('The eighth mlid in the materialized path. See p1.'),
  67       'p9' => t('The ninth mlid in the materialized path. See p1.'),
  68       'updated' => t('Flag that indicates that this link was generated during the update from Drupal 5.'),
  69     ];
  70   }
  71
  72   /**
  73    * {@inheritdoc}
  74    */
  75   public function prepareRow(Row $row) {
  76     $row->setSourceProperty('options', unserialize($row->getSourceProperty('options')));
  77     $row->setSourceProperty('enabled', !$row->getSourceProperty('hidden'));
  78     $row->setSourceProperty('description', Unicode::truncate($row->getSourceProperty('options/attributes/title'), 255));
  79
  80     return parent::prepareRow($row);
  81   }
  82
  83   /**
  84    * {@inheritdoc}
  85    */
  86   public function getIds() {
  87     $ids['mlid']['type'] = 'integer';
  88     $ids['mlid']['alias'] = 'ml';
  89     return $ids;
  90   }
  91
  92 }