' . t("Note: If none of the enabled menus contain an item for a given page, Drupal will look in the 'Navigation' menu by default, even if it is 'disabled' here.") . '
', + ); + + // Orderable list of menu selections. + $form['include_exclude']['menu_breadcrumb_menus'] = array( + '#tree' => TRUE, + '#theme' => 'menu_breadcrumb_menus_table', + ); + + $menus = _menu_breadcrumb_get_menus(); + $weight_delta = count($menus); + + foreach ($menus as $menu_name => $menu) { + // Load menu titles. + $title = !empty($menu['title']) ? $menu['title'] : $menu_name; + + if ($menu['type'] == 'menu') { + $drupal_menu = menu_load($menu_name); + if (!empty($drupal_menu['title'])) { + $title = $drupal_menu['title']; + } + } + + + $safe_id_prefix = 'edit-menu-breadcrumb-menus-'. menu_breadcrumb_html_id($menu_name); + $form['include_exclude']['menu_breadcrumb_menus'][$menu_name] = array( + 'enabled' => array( + '#type' => 'checkbox', + '#id' => $safe_id_prefix .'-enabled', + '#title' => '', + '#default_value' => $menu['enabled'], + ), + 'label' => array( + '#value' => $menu_name, + ), + 'weight' => array( + '#type' => 'weight', + '#default_value' => !empty($menu['weight']) ? (int) $menu['weight'] : 0, + '#delta' => $weight_delta, + '#id' => $safe_id_prefix .'-weight-wrapper', + ), + 'type' => array( + '#type' => 'value', + '#value' => $menu['type'], + ), + 'title' => array( + '#type' => 'value', + '#value' => $title, + ), + 'title_display' => array( + '#type' => 'markup', + '#markup' => \Drupal\Component\Utility\String::checkPlain($title), + ), + ); + + // Provide helpful title attributes for special menus. + $title_field =& $form['include_exclude']['menu_breadcrumb_menus'][$menu_name]['title_display']; + if ($menu['type'] == 'pattern') { + $title_field['#value'] = t( + '@name (@hint)', + array( + '@title' => t("See 'Advanced' settings below."), + '@name' => $title_field['#markup'], + '@hint' => t('pattern'), + ) + ); + } + elseif ($menu['type'] == 'menu_breadcrumb_default_menu') { + $title_field['#value'] = t( + '@text', + array( + '@title' => t('Default setting for future menus.'), + '@text' => t('Default setting (see below)'), + ) + ); + } + } + + $form['include_exclude']['description'] = array( + '#type' => 'markup', + '#prefix' => '', + '#suffix' => '
', + '#value' => t('Default setting is not a real menu - it defines the default position and enabled status for future menus. If it is "enabled", Menu Breadcrumb will automatically consider newly-added menus when establishing breadcrumbs. If it is disabled, new menus will not be used for breadcrumbs until they have explicitly been enabled here.'), + ); + + $form['include_exclude']['advanced'] = array( + '#type' => 'fieldset', + '#title' => t('Advanced'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + ); + + $form['include_exclude']['advanced']['pattern_help'] = array( + '#type' => 'markup', + '#prefix' => '', + '#suffix' => '
', + '#value' => t("Enter regular expressions (one per line) to aggregate matching menu names into a single replacement title in the above list."), + ); + + $form['include_exclude']['advanced']['menu_patterns'] = array( + '#type' => 'textarea', + '#title' => t('Patterns'), + '#default_value' => $config->get('menu_patterns'), + '#description' => t("Syntax: /regex/title/By default, Drupal will use the Navigation menu for the breadcrumb. This module allows you to use the menu the current page belongs to for the breadcrumb.
As an added bonus, it also allows you to append the page title to the breadcrumb (either as a clickable url or not) and hide the breadcrumb if it only contains the link to the front page.
'); - break; - } + $output = ''; + switch ($path) { + case 'admin/config/modules#description': + $output = t('Allows you to use the menu the current page belongs to for the breadcrumb.'); + break; + case 'admin/config/menu_breadcrumb': + $output = t('By default, Drupal will use the Navigation menu for the breadcrumb. This module allows you to use the menu the current page belongs to for the breadcrumb.
As an added bonus, it also allows you to append the page title to the breadcrumb (either as a clickable url or not) and hide the breadcrumb if it only contains the link to the front page.
'); + break; + } - return $output; + return $output; } /** - * Implementation of hook_menu(). + * Implementation of hook_theme(). */ -function menu_breadcrumb_menu() { - $items['admin/config/user-interface/menu-breadcrumb'] = array( - 'title' => 'Menu Breadcrumb', - 'description' => 'Configure menu breadcrumb.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('menu_breadcrumb_admin_settings_form'), - 'access arguments' => array('administer site configuration'), - 'type' => MENU_NORMAL_ITEM, +function menu_breadcrumb_theme() { + return array( + 'menu_breadcrumb_menus_table' => array( + 'render element' => 'form', + ), ); - return $items; } /** - * Default menu item. - * If the module is not yet configured, we only need this - * as a starting point. This determines the default weight - * and 'enabled' status for any new menus. + * Theme a drag-to-reorder table of menu selection checkboxes. */ -function _menu_breadcrumb_default_menu() { - return array( - 'menu_breadcrumb_default_menu' => array( - 'enabled' => 1, - 'weight' => 0, - 'type' => 'menu_breadcrumb_default_menu', - ), +function theme_menu_breadcrumb_menus_table($variables) { + $form = $variables['form']; + drupal_attach_tabledrag($form, array( + 'action' => 'order', + 'relationship' => 'sibling', + 'group' => 'menu-weight', + 'table_id' => 'menu_breadcrumb_menus', + )); + $table['attributes']['id'] = 'menu-breadcrumb-menus' ; + $table['header'] = array( + t('Menu'), + t('Enabled'), + t('Weight'), ); + + // Generate table of draggable menu names. + $rows = array(); + foreach (\Drupal\Core\Render\Element::children($form) as $key) { + if (isset($form[$key]['title_display'])) { + $menu = &$form[$key]; + $row = array(); + $row[] = drupal_render($menu['title_display']); + $row[] = drupal_render($menu['enabled']); + $menu['weight']['#attributes']['class'] = array('menu-weight'); + $row[] = drupal_render($menu['weight']); + $rows[] = array('data' => $row, 'class' => array('draggable')); + } + } + $table['rows'] = $rows; + $table['caption'] = NULL; + $table['colgroups'] = array(); + $table['sticky'] = FALSE; + $table['responsive'] = array(); + $table['empty'] = ''; + return theme_table($table); +} + +/** + * Prepare a string for use as a valid HTML ID and guarantee uniqueness. + * Adapted from Drupal 7's drupal_html_id(). + * + * @param $id + * The ID to clean. + * @return + * The cleaned ID. + */ +function menu_breadcrumb_html_id($id) { + static $seen_ids = array(); + $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => '')); + + // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can + // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"), + // colons (":"), and periods ("."). We strip out any character not in that + // list. Note that the CSS spec doesn't allow colons or periods in identifiers + // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two + // characters as well. + $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id); + + // Ensure IDs are unique. The first occurrence is held but left alone. + // Subsequent occurrences get a number appended to them. This incrementing + // will almost certainly break code that relies on explicit HTML IDs in forms + // that appear more than once on the page, but the alternative is outputting + // duplicate IDs, which would break JS code and XHTML validity anyways. For + // now, it's an acceptable stopgap solution. + if (isset($seen_ids[$id])) { + $id = $id .'-'. ++$seen_ids[$id]; + } + else { + $seen_ids[$id] = 1; + } + + return $id; } /** @@ -73,16 +130,24 @@ function _menu_breadcrumb_default_menu() { function _menu_breadcrumb_get_menus() { static $menus; if (!isset($menus)) { + $config = Drupal::config('menu_breadcrumb.menu'); // Fetch stored or default settings. - $menus = variable_get('menu_breadcrumb_menus', _menu_breadcrumb_default_menu()); + $menus = $config->get('menu_breadcrumb_menus'); + if (empty($menus)) { + $menus = _menu_breadcrumb_default_menu(); + } // Load the pattern match cache (to avoid any unnecessary regex matching). // Submitting the settings form requires us to rebuild this cache, as // the patterns may have changed. - $match_cache = variable_get('menu_breadcrumb_pattern_matches', array()); - $match_cache_rebuild = variable_get('menu_breadcrumb_pattern_matches_rebuild', FALSE); + $match_cache = $config->get('pattern_matches'); + if (empty($match_cache)) { + $match_cache = array(); + } + + $match_cache_rebuild = $config->get('pattern_matches_rebuild'); if ($match_cache_rebuild) { - variable_set('menu_breadcrumb_pattern_matches_rebuild', FALSE); + $config->set('pattern_matches_rebuild', FALSE); $match_cache_old = $match_cache; $match_cache = array(); } @@ -93,7 +158,9 @@ function _menu_breadcrumb_get_menus() { // Find new/unknown menus. If rebuilding the pattern match cache, // we also treat previously-matched menus (i.e. those currently // 'replaced' by a pattern) as new. - $drupal_menu_names = menu_get_names(); + + $drupal_menu_names = menu_get_menus(); + $unknown_menu_names = array_diff($drupal_menu_names, array_keys($menus), array_keys($match_cache)); if ($unknown_menu_names) { $new_menus = _menu_breadcrumb_process_unknown_menus($unknown_menu_names, $menus, $match_cache_old, $match_cache_rebuild); @@ -117,17 +184,45 @@ function _menu_breadcrumb_get_menus() { // Remove any defunct menu names. Only visible if we are showing // the admin settings form, so don't waste time processing this // otherwise. - if ($_GET['q'] == 'admin/config/user-interface/menu-breadcrumb') { + if (_current_path() == 'admin/config/user-interface/menu-breadcrumb') { $current_menu_names = array_merge($drupal_menu_names, array_unique($match_cache), array('menu_breadcrumb_default_menu')); $menus_current = array_intersect(array_keys($menus), $current_menu_names); $menus = array_intersect_key($menus, array_flip($menus_current)); } } - return $menus; } /** + * Get the menu/selection list. + * + * @return + * An array indicating the enabled status of each menu. + */ +function menu_breadcrumb_menu_list() { + static $list; + + if (!isset($list)) { + $menus = _menu_breadcrumb_get_menus(); + unset($menus['menu_breadcrumb_default_menu']); + + $list = array(); + foreach ($menus as $name => $menu) { + $list[$name] = (bool) $menu['enabled']; + } + + // Enable other modules to dynamically modify the menu list + // (for example, to make the order depend upon the current + // user's language preference). + if ($hook = \Drupal::moduleHandler()->invokeAll('menu_breadcrumb_menu_list', $list)) { + $list = $hook; + } + } + + return $list; +} + +/** * Helper for _menu_breadcrumb_get_menus(). * Determine whether each 'unknown' menu is genuinely new, * or was previously aggregated by a pattern match. @@ -149,9 +244,9 @@ function _menu_breadcrumb_process_unknown_menus($unknown_menu_names, $menus, $ma foreach ($unknown_menu_names as $menu_name) { $previously_matched = ($match_cache_rebuild - && array_key_exists($menu_name, $match_cache_old) - && ($pattern = $match_cache_old[$menu_name]) - && array_key_exists($pattern, $menus)); + && array_key_exists($menu_name, $match_cache_old) + && ($pattern = $match_cache_old[$menu_name]) + && array_key_exists($pattern, $menus)); if ($previously_matched) { // Use the known enabled/weight values for this pattern. $enabled = $menus[$pattern]['enabled']; @@ -180,8 +275,12 @@ function _menu_breadcrumb_process_unknown_menus($unknown_menu_names, $menus, $ma */ function _menu_breadcrumb_process_new_menus($new_menus, &$menus, &$match_cache, $match_cache_rebuild) { // Load the current regex patterns. + $config = Drupal::config('menu_breadcrumb.menu'); $patterns = array(); - $menu_patterns = variable_get('menu_breadcrumb_menu_patterns', MENU_BREADCRUMB_REGEX_DEFAULT); + $menu_patterns = $config->get('menu_patterns'); + if (is_null($menu_patterns)) { + $menu_patterns = MENU_BREADCRUMB_REGEX_DEFAULT; + } $menu_patterns = array_filter(explode("\n", $menu_patterns)); foreach ($menu_patterns as $pattern) { $part = array(); @@ -231,7 +330,7 @@ function _menu_breadcrumb_process_new_menus($new_menus, &$menus, &$match_cache, } } if ($update_match_cache) { - variable_set('menu_breadcrumb_pattern_matches', $match_cache); + $config->set('pattern_matches', $match_cache)->save(); } } @@ -242,7 +341,8 @@ function _menu_breadcrumb_process_new_menus($new_menus, &$menus, &$match_cache, $menus[$menu_name]['name'] = $menu_name; } uasort($menus, '_menu_breadcrumb_sort'); // sort by weight. - variable_set('menu_breadcrumb_menus', $menus); + $config->set('menus', $menus); + $config->save(); } /** @@ -261,73 +361,51 @@ function _menu_breadcrumb_sort($menu1, $menu2) { } /** - * Get the menu/selection list. - * - * @return - * An array indicating the enabled status of each menu. - */ -function menu_breadcrumb_menu_list() { - static $list; - - if (!isset($list)) { - $menus = _menu_breadcrumb_get_menus(); - unset($menus['menu_breadcrumb_default_menu']); - - $list = array(); - foreach ($menus as $name => $menu) { - $list[$name] = (bool) $menu['enabled']; - } - - // Enable other modules to dynamically modify the menu list - // (for example, to make the order depend upon the current - // user's language preference). - if ($hook = module_invoke_all('menu_breadcrumb_menu_list', $list)) { - $list = $hook; - } - } - - return $list; -} - -/** - * Implementation of hook_menu_breadcrumb_alter(). - * - * Alter links in the active trail before it is rendered as the breadcrumb. + * Default menu item. + * If the module is not yet configured, we only need this + * as a starting point. This determines the default weight + * and 'enabled' status for any new menus. */ -function menu_breadcrumb_menu_breadcrumb_alter(&$active_trail, $item) { - // Removes "Home" link to the front page, in case you already have one. - if (variable_get('menu_breadcrumb_remove_home_link', FALSE) && $active_trail[0]['href'] === '', - '#suffix' => '
', - '#value' => t("Note: If none of the enabled menus contain an item for a given page, Drupal will look in the 'Navigation' menu by default, even if it is 'disabled' here."), - ); - - // Orderable list of menu selections. - $form['include_exclude']['menu_breadcrumb_menus'] = array( - '#tree' => TRUE, - '#theme' => 'menu_breadcrumb_menus_table', - ); - - // Load stored configuration. - $menus = _menu_breadcrumb_get_menus(); - $weight_delta = count($menus); - - foreach ($menus as $menu_name => $menu) { - // Load menu titles. - $title = !empty($menu['title']) ? $menu['title'] : $menu_name; - if ($menu['type'] == 'menu') { - $drupal_menu = menu_load($menu_name); - if (!empty($drupal_menu['title'])) { - $title = $drupal_menu['title']; - } - } - - // Ensure that regex patterns do not cause invalid id attributes. - $safe_id_prefix = 'edit-menu-breadcrumb-menus-'. menu_breadcrumb_html_id($menu_name); - - $form['include_exclude']['menu_breadcrumb_menus'][$menu_name] = array( - 'enabled' => array( - '#type' => 'checkbox', - '#id' => $safe_id_prefix .'-enabled', - '#title' => '', - '#default_value' => $menu['enabled'], - ), - 'label' => array( - '#value' => $menu_name, - ), - 'weight' => array( - '#type' => 'weight', - '#default_value' => !empty($menu['weight']) ? (int) $menu['weight'] : 0, - '#delta' => $weight_delta, - '#id' => $safe_id_prefix .'-weight-wrapper', - ), - 'type' => array( - '#type' => 'value', - '#value' => $menu['type'], - ), - 'title' => array( - '#type' => 'value', - '#value' => $title, - ), - 'title_display' => array( - '#type' => 'markup', - '#markup' => check_plain($title), - ), - ); - - // Provide helpful title attributes for special menus. - $title_field =& $form['include_exclude']['menu_breadcrumb_menus'][$menu_name]['title_display']; - if ($menu['type'] == 'pattern') { - $title_field['#value'] = t( - '@name (@hint)', - array( - '@title' => t("See 'Advanced' settings below."), - '@name' => $title_field['#markup'], - '@hint' => t('pattern'), - ) - ); - } - elseif ($menu['type'] == 'menu_breadcrumb_default_menu') { - $title_field['#value'] = t( - '@text', - array( - '@title' => t('Default setting for future menus.'), - '@text' => t('Default setting (see below)'), - ) - ); - } - } - - $form['include_exclude']['description'] = array( - '#type' => 'markup', - '#prefix' => '', - '#suffix' => '
', - '#value' => t('Default setting is not a real menu - it defines the default position and enabled status for future menus. If it is "enabled", Menu Breadcrumb will automatically consider newly-added menus when establishing breadcrumbs. If it is disabled, new menus will not be used for breadcrumbs until they have explicitly been enabled here.'), - ); - - $form['include_exclude']['advanced'] = array( - '#type' => 'fieldset', - '#title' => t('Advanced'), - '#collapsible' => TRUE, - '#collapsed' => TRUE, - ); - - $form['include_exclude']['advanced']['pattern_help'] = array( - '#type' => 'markup', - '#prefix' => '', - '#suffix' => '
', - '#value' => t("Enter regular expressions (one per line) to aggregate matching menu names into a single replacement title in the above list."), - ); - - $form['include_exclude']['advanced']['menu_breadcrumb_menu_patterns'] = array( - '#type' => 'textarea', - '#title' => t('Patterns'), - '#default_value' => variable_get('menu_breadcrumb_menu_patterns', MENU_BREADCRUMB_REGEX_DEFAULT), - '#description' => t("Syntax: /regex/title/