www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/menu_ui/menu_ui.module

   1 <?php
   2
   3 /**
   4  * @file
   5  * Allows administrators to customize the site's navigation menus.
   6  *
   7  * A menu (in this context) is a hierarchical collection of links, generally
   8  * used for navigation.
   9  */
  10
  11 use Drupal\Core\Breadcrumb\Breadcrumb;
  12 use Drupal\Core\Cache\CacheableMetadata;
  13 use Drupal\Core\Block\BlockPluginInterface;
  14 use Drupal\Core\Link;
  15 use Drupal\Core\Menu\MenuLinkInterface;
  16 use Drupal\Core\Form\FormStateInterface;
  17 use Drupal\Core\Routing\RouteMatchInterface;
  18 use Drupal\menu_link_content\Entity\MenuLinkContent;
  19 use Drupal\node\NodeTypeInterface;
  20 use Drupal\system\Entity\Menu;
  21 use Drupal\node\NodeInterface;
  22
  23 /**
  24  * Maximum length of menu name as entered by the user.
  25  *
  26  * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. Use
  27  *   \Drupal\Core\Config\Entity\ConfigEntityStorage::MAX_ID_LENGTH because the
  28  *   menu name is a configuration entity ID.
  29  *
  30  * @see https://www.drupal.org/node/2831620
  31  */
  32 const MENU_MAX_MENU_NAME_LENGTH_UI = 27;
  33
  34 /**
  35  * Implements hook_help().
  36  */
  37 function menu_ui_help($route_name, RouteMatchInterface $route_match) {
  38   switch ($route_name) {
  39     case 'help.page.menu_ui':
  40       $output = '';
  41       $output .= '<h3>' . t('About') . '</h3>';
  42       $output .= '<p>' . t('The Menu UI module provides an interface for managing menus. A menu is a hierarchical collection of links, which can be within or external to the site, generally used for navigation. For more information, see the <a href=":menu">online documentation for the Menu UI module</a>.', [':menu' => 'https://www.drupal.org/documentation/modules/menu/']) . '</p>';
  43       $output .= '<h3>' . t('Uses') . '</h3>';
  44       $output .= '<dl>';
  45       $output .= '<dt>' . t('Managing menus') . '</dt>';
  46       $output .= '<dd>' . t('Users with the <em>Administer menus and menu items</em> permission can add, edit, and delete custom menus on the <a href=":menu">Menus page</a>. Custom menus can be special site menus, menus of external links, or any combination of internal and external links. You may create an unlimited number of additional menus, each of which will automatically have an associated block (if you have the <a href=":block_help">Block module</a> installed). By selecting <em>Edit menu</em>, you can add, edit, or delete links for a given menu. The links listing page provides a drag-and-drop interface for controlling the order of links, and creating a hierarchy within the menu.', [':block_help' => (\Drupal::moduleHandler()->moduleExists('block')) ? \Drupal::url('help.page', ['name' => 'block']) : '#', ':menu' => \Drupal::url('entity.menu.collection')]) . '</dd>';
  47       $output .= '<dt>' . t('Displaying menus') . '</dt>';
  48       $output .= '<dd>' . t('If you have the Block module enabled, then each menu that you create is rendered in a block that you enable and position on the <a href=":blocks">Block layout page</a>. In some <a href=":themes">themes</a>, the main menu and possibly the secondary menu will be output automatically; you may be able to disable this behavior on the <a href=":themes">theme\'s settings page</a>.', [':blocks' => (\Drupal::moduleHandler()->moduleExists('block')) ? \Drupal::url('block.admin_display') : '#', ':themes' => \Drupal::url('system.themes_page'), ':theme_settings' => \Drupal::url('system.theme_settings')]) . '</dd>';
  49       $output .= '</dl>';
  50       return $output;
  51   }
  52   if ($route_name == 'entity.menu.add_form' && \Drupal::moduleHandler()->moduleExists('block') && \Drupal::currentUser()->hasPermission('administer blocks')) {
  53     return '<p>' . t('You can enable the newly-created block for this menu on the <a href=":blocks">Block layout page</a>.', [':blocks' => \Drupal::url('block.admin_display')]) . '</p>';
  54   }
  55   elseif ($route_name == 'entity.menu.collection' && \Drupal::moduleHandler()->moduleExists('block') && \Drupal::currentUser()->hasPermission('administer blocks')) {
  56     return '<p>' . t('Each menu has a corresponding block that is managed on the <a href=":blocks">Block layout page</a>.', [':blocks' => \Drupal::url('block.admin_display')]) . '</p>';
  57   }
  58 }
  59
  60 /**
  61  * Implements hook_entity_type_build().
  62  */
  63 function menu_ui_entity_type_build(array &$entity_types) {
  64   /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
  65   $entity_types['menu']
  66     ->setFormClass('add', 'Drupal\menu_ui\MenuForm')
  67     ->setFormClass('edit', 'Drupal\menu_ui\MenuForm')
  68     ->setFormClass('delete', 'Drupal\menu_ui\Form\MenuDeleteForm')
  69     ->setListBuilderClass('Drupal\menu_ui\MenuListBuilder')
  70     ->setLinkTemplate('add-form', '/admin/structure/menu/add')
  71     ->setLinkTemplate('delete-form', '/admin/structure/menu/manage/{menu}/delete')
  72     ->setLinkTemplate('edit-form', '/admin/structure/menu/manage/{menu}')
  73     ->setLinkTemplate('add-link-form', '/admin/structure/menu/manage/{menu}/add')
  74     ->setLinkTemplate('collection', '/admin/structure/menu');
  75
  76   if (isset($entity_types['node'])) {
  77     $entity_types['node']->addConstraint('MenuSettings', []);
  78   }
  79 }
  80
  81 /**
  82  * Implements hook_block_view_BASE_BLOCK_ID_alter() for 'system_menu_block'.
  83  */
  84 function menu_ui_block_view_system_menu_block_alter(array &$build, BlockPluginInterface $block) {
  85   if ($block->getBaseId() == 'system_menu_block') {
  86     $menu_name = $block->getDerivativeId();
  87     $build['#contextual_links']['menu'] = [
  88       'route_parameters' => ['menu' => $menu_name],
  89     ];
  90   }
  91 }
  92
  93 /**
  94  * Helper function to create or update a menu link for a node.
  95  *
  96  * @param \Drupal\node\NodeInterface $node
  97  *   Node entity.
  98  * @param array $values
  99  *   Values for the menu link.
 100  */
 101 function _menu_ui_node_save(NodeInterface $node, array $values) {
 102   /** @var \Drupal\menu_link_content\MenuLinkContentInterface $entity */
 103   if (!empty($values['entity_id'])) {
 104     $entity = MenuLinkContent::load($values['entity_id']);
 105     if ($entity->isTranslatable()) {
 106       if (!$entity->hasTranslation($node->language()->getId())) {
 107         $entity = $entity->addTranslation($node->language()->getId(), $entity->toArray());
 108       }
 109       else {
 110         $entity = $entity->getTranslation($node->language()->getId());
 111       }
 112     }
 113   }
 114   else {
 115     // Create a new menu_link_content entity.
 116     $entity = MenuLinkContent::create([
 117       'link' => ['uri' => 'entity:node/' . $node->id()],
 118       'langcode' => $node->language()->getId(),
 119     ]);
 120     $entity->enabled->value = 1;
 121   }
 122   $entity->title->value = trim($values['title']);
 123   $entity->description->value = trim($values['description']);
 124   $entity->menu_name->value = $values['menu_name'];
 125   $entity->parent->value = $values['parent'];
 126   $entity->weight->value = isset($values['weight']) ? $values['weight'] : 0;
 127   $entity->save();
 128 }
 129
 130 /**
 131  * Returns the definition for a menu link for the given node.
 132  *
 133  * @param \Drupal\node\NodeInterface $node
 134  *   The node entity.
 135  *
 136  * @return array
 137  *   An array that contains default values for the menu link form.
 138  */
 139 function menu_ui_get_menu_link_defaults(NodeInterface $node) {
 140   // Prepare the definition for the edit form.
 141   /** @var \Drupal\node\NodeTypeInterface $node_type */
 142   $node_type = $node->type->entity;
 143   $menu_name = strtok($node_type->getThirdPartySetting('menu_ui', 'parent', 'main:'), ':');
 144   $defaults = FALSE;
 145   if ($node->id()) {
 146     $id = FALSE;
 147     // Give priority to the default menu
 148     $type_menus = $node_type->getThirdPartySetting('menu_ui', 'available_menus', ['main']);
 149     if (in_array($menu_name, $type_menus)) {
 150       $query = \Drupal::entityQuery('menu_link_content')
 151         ->condition('link.uri', 'node/' . $node->id())
 152         ->condition('menu_name', $menu_name)
 153         ->sort('id', 'ASC')
 154         ->range(0, 1);
 155       $result = $query->execute();
 156
 157       $id = (!empty($result)) ? reset($result) : FALSE;
 158     }
 159     // Check all allowed menus if a link does not exist in the default menu.
 160     if (!$id && !empty($type_menus)) {
 161       $query = \Drupal::entityQuery('menu_link_content')
 162         ->condition('link.uri', 'entity:node/' . $node->id())
 163         ->condition('menu_name', array_values($type_menus), 'IN')
 164         ->sort('id', 'ASC')
 165         ->range(0, 1);
 166       $result = $query->execute();
 167
 168       $id = (!empty($result)) ? reset($result) : FALSE;
 169     }
 170     if ($id) {
 171       $menu_link = MenuLinkContent::load($id);
 172       $menu_link = \Drupal::service('entity.repository')->getTranslationFromContext($menu_link);
 173       $defaults = [
 174         'entity_id' => $menu_link->id(),
 175         'id' => $menu_link->getPluginId(),
 176         'title' => $menu_link->getTitle(),
 177         'title_max_length' => $menu_link->getFieldDefinitions()['title']->getSetting('max_length'),
 178         'description' => $menu_link->getDescription(),
 179         'description_max_length' => $menu_link->getFieldDefinitions()['description']->getSetting('max_length'),
 180         'menu_name' => $menu_link->getMenuName(),
 181         'parent' => $menu_link->getParentId(),
 182         'weight' => $menu_link->getWeight(),
 183       ];
 184     }
 185   }
 186
 187   if (!$defaults) {
 188     // Get the default max_length of a menu link title from the base field
 189     // definition.
 190     $field_definitions = \Drupal::entityManager()->getBaseFieldDefinitions('menu_link_content');
 191     $max_length = $field_definitions['title']->getSetting('max_length');
 192     $description_max_length = $field_definitions['description']->getSetting('max_length');
 193     $defaults = [
 194       'entity_id' => 0,
 195       'id' => '',
 196       'title' => '',
 197       'title_max_length' => $max_length,
 198       'description' => '',
 199       'description_max_length' => $description_max_length,
 200       'menu_name' => $menu_name,
 201       'parent' => '',
 202       'weight' => 0,
 203     ];
 204   }
 205   return $defaults;
 206 }
 207
 208 /**
 209  * Implements hook_form_BASE_FORM_ID_alter() for \Drupal\node\NodeForm.
 210  *
 211  * Adds menu item fields to the node form.
 212  *
 213  * @see menu_ui_form_node_form_submit()
 214  */
 215 function menu_ui_form_node_form_alter(&$form, FormStateInterface $form_state) {
 216   // Generate a list of possible parents (not including this link or descendants).
 217   // @todo This must be handled in a #process handler.
 218   $node = $form_state->getFormObject()->getEntity();
 219   $defaults = menu_ui_get_menu_link_defaults($node);
 220   /** @var \Drupal\node\NodeTypeInterface $node_type */
 221   $node_type = $node->type->entity;
 222   /** @var \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector */
 223   $menu_parent_selector = \Drupal::service('menu.parent_form_selector');
 224   $type_menus_ids = $node_type->getThirdPartySetting('menu_ui', 'available_menus', ['main']);
 225   if (empty($type_menus_ids)) {
 226     return;
 227   }
 228   /** @var \Drupal\system\MenuInterface[] $type_menus */
 229   $type_menus = Menu::loadMultiple($type_menus_ids);
 230   $available_menus = [];
 231   foreach ($type_menus as $menu) {
 232     $available_menus[$menu->id()] = $menu->label();
 233   }
 234   if ($defaults['id']) {
 235     $default = $defaults['menu_name'] . ':' . $defaults['parent'];
 236   }
 237   else {
 238     $default = $node_type->getThirdPartySetting('menu_ui', 'parent', 'main:');
 239   }
 240   $parent_element = $menu_parent_selector->parentSelectElement($default, $defaults['id'], $available_menus);
 241   // If no possible parent menu items were found, there is nothing to display.
 242   if (empty($parent_element)) {
 243     return;
 244   }
 245
 246   $form['menu'] = [
 247     '#type' => 'details',
 248     '#title' => t('Menu settings'),
 249     '#access' => \Drupal::currentUser()->hasPermission('administer menu'),
 250     '#open' => (bool) $defaults['id'],
 251     '#group' => 'advanced',
 252     '#attached' => [
 253       'library' => ['menu_ui/drupal.menu_ui'],
 254     ],
 255     '#tree' => TRUE,
 256     '#weight' => -2,
 257     '#attributes' => ['class' => ['menu-link-form']],
 258   ];
 259   $form['menu']['enabled'] = [
 260     '#type' => 'checkbox',
 261     '#title' => t('Provide a menu link'),
 262     '#default_value' => (int) (bool) $defaults['id'],
 263   ];
 264   $form['menu']['link'] = [
 265     '#type' => 'container',
 266     '#parents' => ['menu'],
 267     '#states' => [
 268       'invisible' => [
 269         'input[name="menu[enabled]"]' => ['checked' => FALSE],
 270       ],
 271     ],
 272   ];
 273
 274   // Populate the element with the link data.
 275   foreach (['id', 'entity_id'] as $key) {
 276     $form['menu']['link'][$key] = ['#type' => 'value', '#value' => $defaults[$key]];
 277   }
 278
 279   $form['menu']['link']['title'] = [
 280     '#type' => 'textfield',
 281     '#title' => t('Menu link title'),
 282     '#default_value' => $defaults['title'],
 283     '#maxlength' => $defaults['title_max_length'],
 284   ];
 285
 286   $form['menu']['link']['description'] = [
 287     '#type' => 'textfield',
 288     '#title' => t('Description'),
 289     '#default_value' => $defaults['description'],
 290     '#description' => t('Shown when hovering over the menu link.'),
 291     '#maxlength' => $defaults['description_max_length'],
 292   ];
 293
 294   $form['menu']['link']['menu_parent'] = $parent_element;
 295   $form['menu']['link']['menu_parent']['#title'] = t('Parent item');
 296   $form['menu']['link']['menu_parent']['#attributes']['class'][] = 'menu-parent-select';
 297
 298   $form['menu']['link']['weight'] = [
 299     '#type' => 'number',
 300     '#title' => t('Weight'),
 301     '#default_value' => $defaults['weight'],
 302     '#description' => t('Menu links with lower weights are displayed before links with higher weights.'),
 303   ];
 304
 305   foreach (array_keys($form['actions']) as $action) {
 306     if ($action != 'preview' && isset($form['actions'][$action]['#type']) && $form['actions'][$action]['#type'] === 'submit') {
 307       $form['actions'][$action]['#submit'][] = 'menu_ui_form_node_form_submit';
 308     }
 309   }
 310
 311   $form['#entity_builders'][] = 'menu_ui_node_builder';
 312 }
 313
 314 /**
 315  * Entity form builder to add the menu information to the node.
 316  */
 317 function menu_ui_node_builder($entity_type, NodeInterface $entity, &$form, FormStateInterface $form_state) {
 318   $entity->menu = $form_state->getValue('menu');
 319 }
 320
 321 /**
 322  * Form submission handler for menu item field on the node form.
 323  *
 324  * @see menu_ui_form_node_form_alter()
 325  */
 326 function menu_ui_form_node_form_submit($form, FormStateInterface $form_state) {
 327   $node = $form_state->getFormObject()->getEntity();
 328   if (!$form_state->isValueEmpty('menu')) {
 329     $values = $form_state->getValue('menu');
 330     if (empty($values['enabled'])) {
 331       if ($values['entity_id']) {
 332         $entity = MenuLinkContent::load($values['entity_id']);
 333         $entity->delete();
 334       }
 335     }
 336     elseif (trim($values['title'])) {
 337       // Decompose the selected menu parent option into 'menu_name' and 'parent',
 338       // if the form used the default parent selection widget.
 339       if (!empty($values['menu_parent'])) {
 340         list($menu_name, $parent) = explode(':', $values['menu_parent'], 2);
 341         $values['menu_name'] = $menu_name;
 342         $values['parent'] = $parent;
 343       }
 344       _menu_ui_node_save($node, $values);
 345     }
 346   }
 347 }
 348
 349 /**
 350  * Implements hook_form_FORM_ID_alter() for \Drupal\node\NodeTypeForm.
 351  *
 352  * Adds menu options to the node type form.
 353  *
 354  * @see NodeTypeForm::form()
 355  * @see menu_ui_form_node_type_form_submit()
 356  */
 357 function menu_ui_form_node_type_form_alter(&$form, FormStateInterface $form_state) {
 358   /** @var \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector */
 359   $menu_parent_selector = \Drupal::service('menu.parent_form_selector');
 360   $menu_options = menu_ui_get_menus();
 361   /** @var \Drupal\node\NodeTypeInterface $type */
 362   $type = $form_state->getFormObject()->getEntity();
 363   $form['menu'] = [
 364     '#type' => 'details',
 365     '#title' => t('Menu settings'),
 366     '#attached' => [
 367       'library' => ['menu_ui/drupal.menu_ui.admin'],
 368     ],
 369     '#group' => 'additional_settings',
 370   ];
 371   $form['menu']['menu_options'] = [
 372     '#type' => 'checkboxes',
 373     '#title' => t('Available menus'),
 374     '#default_value' => $type->getThirdPartySetting('menu_ui', 'available_menus', ['main']),
 375     '#options' => $menu_options,
 376     '#description' => t('The menus available to place links in for this content type.'),
 377   ];
 378   // @todo See if we can avoid pre-loading all options by changing the form or
 379   //   using a #process callback. https://www.drupal.org/node/2310319
 380   //   To avoid an 'illegal option' error after saving the form we have to load
 381   //   all available menu parents. Otherwise, it is not possible to dynamically
 382   //   add options to the list using ajax.
 383   $options_cacheability = new CacheableMetadata();
 384   $options = $menu_parent_selector->getParentSelectOptions('', NULL, $options_cacheability);
 385   $form['menu']['menu_parent'] = [
 386     '#type' => 'select',
 387     '#title' => t('Default parent item'),
 388     '#default_value' => $type->getThirdPartySetting('menu_ui', 'parent', 'main:'),
 389     '#options' => $options,
 390     '#description' => t('Choose the menu item to be the default parent for a new link in the content authoring form.'),
 391     '#attributes' => ['class' => ['menu-title-select']],
 392   ];
 393   $options_cacheability->applyTo($form['menu']['menu_parent']);
 394
 395   $form['#validate'][] = 'menu_ui_form_node_type_form_validate';
 396   $form['#entity_builders'][] = 'menu_ui_form_node_type_form_builder';
 397 }
 398
 399 /**
 400  * Validate handler for forms with menu options.
 401  *
 402  * @see menu_ui_form_node_type_form_alter()
 403  */
 404 function menu_ui_form_node_type_form_validate(&$form, FormStateInterface $form_state) {
 405   $available_menus = array_filter($form_state->getValue('menu_options'));
 406   // If there is at least one menu allowed, the selected item should be in
 407   // one of them.
 408   if (count($available_menus)) {
 409     $menu_item_id_parts = explode(':', $form_state->getValue('menu_parent'));
 410     if (!in_array($menu_item_id_parts[0], $available_menus)) {
 411       $form_state->setErrorByName('menu_parent', t('The selected menu item is not under one of the selected menus.'));
 412     }
 413   }
 414   else {
 415     $form_state->setValue('menu_parent', '');
 416   }
 417 }
 418
 419 /**
 420  * Entity builder for the node type form with menu options.
 421  *
 422  * @see menu_ui_form_node_type_form_alter()
 423  */
 424 function menu_ui_form_node_type_form_builder($entity_type, NodeTypeInterface $type, &$form, FormStateInterface $form_state) {
 425   $type->setThirdPartySetting('menu_ui', 'available_menus', array_values(array_filter($form_state->getValue('menu_options'))));
 426   $type->setThirdPartySetting('menu_ui', 'parent', $form_state->getValue('menu_parent'));
 427 }
 428
 429 /**
 430  * Return an associative array of the custom menus names.
 431  *
 432  * @param bool $all
 433  *   (optional) If FALSE return only user-added menus, or if TRUE also include
 434  *   the menus defined by the system. Defaults to TRUE.
 435  *
 436  * @return array
 437  *   An array with the machine-readable names as the keys, and human-readable
 438  *   titles as the values.
 439  */
 440 function menu_ui_get_menus($all = TRUE) {
 441   if ($custom_menus = Menu::loadMultiple()) {
 442     if (!$all) {
 443       $custom_menus = array_diff_key($custom_menus, menu_list_system_menus());
 444     }
 445     foreach ($custom_menus as $menu_name => $menu) {
 446       $custom_menus[$menu_name] = $menu->label();
 447     }
 448     asort($custom_menus);
 449   }
 450   return $custom_menus;
 451 }
 452
 453 /**
 454  * Implements hook_preprocess_HOOK() for block templates.
 455  */
 456 function menu_ui_preprocess_block(&$variables) {
 457   if ($variables['configuration']['provider'] == 'menu_ui') {
 458     $variables['attributes']['role'] = 'navigation';
 459   }
 460 }
 461
 462 /**
 463  * Implements hook_system_breadcrumb_alter().
 464  */
 465 function menu_ui_system_breadcrumb_alter(Breadcrumb &$breadcrumb, RouteMatchInterface $route_match, array $context) {
 466   // Custom breadcrumb behavior for editing menu links, we append a link to
 467   // the menu in which the link is found.
 468   if (($route_match->getRouteName() == 'menu_ui.link_edit') && $menu_link = $route_match->getParameter('menu_link_plugin')) {
 469     if (($menu_link instanceof MenuLinkInterface)) {
 470       // Add a link to the menu admin screen.
 471       $menu = Menu::load($menu_link->getMenuName());
 472       $breadcrumb->addLink(Link::createFromRoute($menu->label(), 'entity.menu.edit_form', ['menu' => $menu->id()]));
 473     }
 474   }
 475 }