public function MenuLink::fields in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/menu_link_content/src/Plugin/migrate/source/MenuLink.php \Drupal\menu_link_content\Plugin\migrate\source\MenuLink::fields()

Returns available fields on the source.

Return value

array Available fields in the source, keys are the field machine names as used in field mappings, values are descriptions.

Overrides MigrateSourceInterface::fields

File

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

Contains \Drupal\menu_link_content\Plugin\migrate\source\MenuLink.

Class

MenuLink

Drupal menu link source from database.

Namespace

Drupal\menu_link_content\Plugin\migrate\source

Code

public function fields() {
  return array(
    'menu_name' => t("The menu name. All links with the same menu name (such as 'navigation') are part of the same menu."),
    'mlid' => t('The menu link ID (mlid) is the integer primary key.'),
    '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.'),
    'link_path' => t('The Drupal path or external path this link points to.'),
    'router_path' => t('For links corresponding to a Drupal path (external = 0), this connects the link to a {menu_router}.path for joins.'),
    'link_title' => t('The text displayed for the link, which may be modified by a title callback stored in {menu_router}.'),
    'options' => t('A serialized array of options to be passed to the url() or l() function, such as a query string or HTML attributes.'),
    'module' => t('The name of the module that generated this link.'),
    '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)'),
    'external' => 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' => t('Flag indicating whether any links have this link as a parent (1 = children exist, 0 = no children).'),
    '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)'),
    'weight' => t('Link weight among links in the same menu at the same depth.'),
    'depth' => t('The depth relative to the top level. A link with plid == 0 will have depth == 1.'),
    'customized' => t('A flag to indicate that the user has manually created or edited the link (1 = customized, 0 = not customized).'),
    '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.'),
    'p2' => t('The second mlid in the materialized path. See p1.'),
    'p3' => t('The third mlid in the materialized path. See p1.'),
    'p4' => t('The fourth mlid in the materialized path. See p1.'),
    'p5' => t('The fifth mlid in the materialized path. See p1.'),
    'p6' => t('The sixth mlid in the materialized path. See p1.'),
    'p7' => t('The seventh mlid in the materialized path. See p1.'),
    'p8' => t('The eighth mlid in the materialized path. See p1.'),
    'p9' => t('The ninth mlid in the materialized path. See p1.'),
    'updated' => t('Flag that indicates that this link was generated during the update from Drupal 5.'),
  );
}