function MenuLink::fields

Overrides MigrateSourceInterface::fields

File

core/modules/menu_link_content/src/Plugin/migrate/source/MenuLink.php, line 80

Class

MenuLink

Drupal 6/7 menu link source from database.

Namespace

Code

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;
}