ultimenu.utilities.inc in Ultimenu 7

Misc functions that hardly change.

File

includes/ultimenu.utilities.inc

<?php

/**
 * @file
 * Misc functions that hardly change.
 */

/**
 * Retrieves stored CSS files for Ultimenu skins.
 *
 * @param bool $refresh
 *   If TRUE, reload the CSS and flush the cached version.
 *
 * @return array
 *   An array of available CSS files.
 */
function ultimenu_get_skins($refresh = FALSE) {
  $skins =& drupal_static(__FUNCTION__);
  if (!isset($skins) || $refresh) {
    if (!$refresh && ($cache = cache_get('ultimenu:skin'))) {
      $skins = $cache->data;
    }
    else {
      $theme_skin = drupal_get_path('theme', variable_get('theme_default', 'bartik')) . '/css/ultimenu';
      $custom_skin = ultimenu_get_settings('skins');
      $module_skin = drupal_get_path('module', 'ultimenu') . '/skins';
      $mask = '/.css$/';
      $files = array();
      if (is_dir($module_skin)) {
        foreach (file_scan_directory($module_skin, $mask) as $filename => $file) {
          $files[$filename] = $file;
        }
      }
      if (!empty($custom_skin) && is_dir($custom_skin)) {
        foreach (file_scan_directory($custom_skin, $mask) as $filename => $file) {
          $files[$filename] = $file;
        }
      }
      if (is_dir($theme_skin)) {
        foreach (file_scan_directory($theme_skin, $mask) as $filename => $file) {
          $files[$filename] = $file;
        }
      }
      if ($files) {
        $skins = array();
        foreach ($files as $file) {
          $uri = $file->uri;

          // Simplify lengthy deep directory structure.
          if (strpos($uri, $module_skin) !== FALSE) {
            $uri = str_replace($module_skin . '/', "module|", $uri);
          }
          elseif (strpos($uri, $custom_skin) !== FALSE) {
            $uri = str_replace($custom_skin . '/', "custom|", $uri);
          }
          elseif (strpos($uri, $theme_skin) !== FALSE) {
            $uri = str_replace($theme_skin . '/', "theme|", $uri);
          }

          // Convert file name to CSS friendly for option label and styling.
          $skins[$uri] = drupal_html_class($file->name);
        }
        cache_set('ultimenu:skin', $skins, 'cache');
      }
    }
  }
  return $skins;
}

/**
 * Returns the array of enabled Ultimenu regions based on enabled settings.
 */
function ultimenu_regions_enabled($delta = NULL) {
  $regions =& drupal_static(__FUNCTION__);
  if (!isset($regions)) {
    $regions = array();
    $regions_all = ultimenu_regions($delta);

    // First limit to enabled regions from the settings.
    if (($regions_enabled = ultimenu_get_settings('regions')) !== NULL) {
      foreach (array_filter($regions_enabled) as $enabled) {

        // We must depends on enabled menu items as always.
        // A disabled menu item will automatically drop its Ultimenu region.
        if (array_key_exists($enabled, $regions_all)) {
          $regions[$enabled] = $regions_all[$enabled];
        }
      }
    }
  }
  return $regions;
}

/**
 * The array of available Ultimenu regions based on enabled menu items.
 *
 * @param string $delta
 *   The block delta which is the menu name.
 *
 * @return array
 *   An array of regions definition dependent on available main-menu items.
 *
 * @see menu_navigation_links()
 */
function ultimenu_regions($delta = NULL) {
  $regions =& drupal_static(__FUNCTION__);
  if (!isset($regions)) {
    $blocks = ultimenu_get_settings('blocks');
    $goodies = ultimenu_get_settings('goodies');
    $is_mlid = !empty($goodies['ultimenu-mlid']) ? TRUE : FALSE;
    $menu_blocks = is_array($blocks) ? array_filter($blocks) : array(
      $blocks,
    );
    $menus = array();
    if ($delta) {
      $menus[$delta] = menu_navigation_links($delta);
    }
    else {
      foreach ($menu_blocks as $menu_name => $title) {
        $menus[$menu_name] = menu_navigation_links($menu_name);
      }
    }

    // Allow alteration.
    drupal_alter('ultimenu_menus_info', $menus);
    $regions = array();
    foreach ($menus as $menu_key => $menu_items) {
      foreach ($menu_items as $item_key => $item) {
        $name_id = ultimenu_truncate_menu_property($menu_key);
        $name_id_nice = str_replace("_", " ", $name_id);
        $menu_title = check_plain($item['title']);
        if ($is_mlid) {
          $item_id = str_replace('menu-', '', $item_key);
        }
        else {
          $item_id = ultimenu_truncate_menu_property($menu_title, 28);
        }
        $regions["ultimenu_{$name_id}_{$item_id}"] = "Ultimenu:{$name_id_nice}: {$menu_title}";
        $regions = array_unique($regions);
      }
    }

    // Allow alteration.
    drupal_alter('ultimenu_regions_info', $regions);
  }
  return $regions;
}

/**
 * Gets Ultimenu regions from the default theme .info.
 */
function ultimenu_get_ultimenu_theme_info() {
  $regions =& drupal_static(__FUNCTION__);
  if (!isset($regions)) {
    $theme = variable_get('theme_default', 'bartik');
    $file = drupal_get_path('theme', $theme) . '/' . $theme . '.info';

    // Parse theme .info file.
    $info = drupal_parse_info_file($file);
    $regions = array();
    foreach ($info['regions'] as $key => $region) {
      if (array_key_exists($key, ultimenu_regions())) {
        $regions[$key] = $region;
      }
    }
  }
  return $regions;
}

/**
 * Colllects unwanted Ultimenu regions for removal stored in the theme .info.
 *
 * When a menu item disabled or deleted, relevant dynamic Ultimenu regions
 * removed from the system, but theme .info has a copy stored there.
 * System will always keep and display the unwanted.
 * Either manually delete it from .info, or do a force removal if so configured.
 *
 * @return array|bool
 *   The array of unwanted Ultimenu regions from theme .info, or FALSE.
 */
function ultimenu_remove_ultimenu_theme_info() {
  $goodies = ultimenu_get_settings('goodies');
  if (!empty($goodies['force-remove-region']) && ($theme_regions = ultimenu_get_ultimenu_theme_info())) {
    return $theme_regions;
  }
  return FALSE;
}

/**
 * Simplify menu names or menu item titles for region key.
 *
 * If region key is to use menu item title:
 * Region key: ultimenu_LOOOOOOOOOOOOOONGMENUNAME_LOOOOOOOOOOOOOOOOOONGMENUITEM.
 * If region key is to use unfriendly key MLID, we'll only care for menu name.
 * Region key: ultimenu_LOOOOOOOOOOOOOONGMENUNAME_1234
 *
 * @param string $property
 *   The Menu name or menu item title.
 * @param int $max_length
 *   The amount of characters to truncate.
 *
 * @return string
 *   The truncated menu properties ready to use for region key.
 *
 * @see _drupal_bootstrap_full()
 * @see decode_entities()
 */
function ultimenu_truncate_menu_property($property, $max_length = 60) {

  // If multilingual site and transliteration enabled, support transliteration.
  $default_language = language_default();
  if (function_exists('locale') && function_exists('transliteration_clean_filename')) {
    $property = transliteration_clean_filename($property, $default_language->language);
  }
  $property = decode_entities($property);
  $property = drupal_strtolower(str_replace(array(
    'menu-',
    '-menu',
  ), '', $property));
  $property = preg_replace('/[\\W\\s]+/', '_', $property);

  // Trim trailing underscores.
  $property = trim($property, '_');
  $property = truncate_utf8($property, $max_length, TRUE, FALSE);
  return $property;
}

/**
 * Get all available menus, excluding some admin menus.
 */
function ultimenu_get_menus() {
  $menus =& drupal_static(__FUNCTION__);
  if (!isset($menus)) {
    $available_menus = menu_get_menus();
    $exclude_menus = array(
      'devel' => t('Development'),
      'management' => t('Management'),
      'navigation' => t('Navigation'),
    );
    $menus = array_diff_key($available_menus, $exclude_menus);
  }
  return $menus;
}

/**
 * Collects enabled Ultimenu block items.
 */
function ultimenu_get_blocks() {
  $items =& drupal_static(__FUNCTION__);
  if (!isset($items)) {
    $items = array();
    $menus = ultimenu_get_menus();
    foreach ($menus as $delta => $name) {
      if (ultimenu_blocks_enabled($delta)) {
        $items[$delta] = t("@name", array(
          '@name' => $name,
        ));
      }
    }
  }
  return $items;
}

/**
 * Check for an Ultimenu block enabled by settings.
 */
function ultimenu_blocks_enabled($delta) {
  $blocks = ultimenu_get_settings('blocks');
  if (!empty($blocks[$delta])) {
    return TRUE;
  }
  return FALSE;
}

/**
 * A wrapper function for variable_get.
 *
 * Allows storing variables in one place rather than setting and calling each.
 */
function ultimenu_get_settings($setting_name = NULL, $default = NULL) {
  $cache =& drupal_static(__FUNCTION__);
  if (empty($cache)) {
    $settings = variable_get('ultimenu_settings', array());
    if (isset($settings[$setting_name]) && ($setting = $settings[$setting_name]) !== NULL) {
      return $setting;
    }
  }
  else {
    if (isset($cache[$setting_name])) {
      return $cache[$setting_name];
    }
  }
  return $default;
}

/**
 * The configuration for the requested block delta.
 *
 * @param string $delta
 *   The delta that uniquely identifies the block in the block system. If
 *   not specified, the default configuration will be returned.
 *
 * @param bool $original
 *   If TRUE, return as is, otherwise convert url to actual path.
 *
 * @return array
 *   An associated array of configuration options.
 */
function ultimenu_get_config($delta = NULL, $original = FALSE) {
  $config = array(
    'skin' => '',
    'skin_name' => '',
  );

  // Get the block configuration options.
  if ($delta) {
    static $blocks;
    if (!isset($blocks)) {
      $blocks = ultimenu_get_settings('blocks');
    }
    if (!empty($blocks[$delta])) {
      $config['delta'] = $delta;
    }

    // Structure: main_menu => ultimenu-htb:module|ultimenu-orange.css.
    $menu_name = str_replace(array(
      "-",
      "'",
    ), "_", $delta);
    $config['menu_name'] = $delta;
    $config['menu_name_truncated'] = ultimenu_truncate_menu_property($delta);
    $setting = ultimenu_get_settings($menu_name);
    list($config['orientation'], $url) = array_pad(array_map('trim', explode(":", $setting, 2)), 2, NULL);
    if ($original) {
      $config['skin'] = $url;
    }
    else {
      $theme_skin = drupal_get_path('theme', variable_get('theme_default', 'bartik')) . '/css/ultimenu';
      $custom_skin = ultimenu_get_settings('skins');
      $module_skin = drupal_get_path('module', 'ultimenu') . '/skins';
      if (strpos($url, "module|") !== FALSE) {
        $config['skin'] = str_replace("module|", $module_skin . '/', $url);
      }
      elseif (strpos($url, "custom|") !== FALSE) {
        $config['skin'] = str_replace("custom|", $custom_skin . '/', $url);
      }
      elseif (strpos($url, "theme|") !== FALSE) {
        $config['skin'] = str_replace("theme|", $theme_skin . '/', $url);
      }
    }
    if ($skin_name = $url) {
      $skin_name = str_replace(".css", '', substr($skin_name, strrpos($skin_name, '|') + 1));
      $config['skin_name'] = drupal_html_class($skin_name);
    }
  }
  return $config;
}

/**
 * A helper function to generate a list of blocks from a specified region.
 *
 * @param array $region
 *   The string identifier for a Ultimenu region. e.g. "ultimenu_main_about"
 *
 * @return array
 *   The renderable array of blocks within the region.
 */
function ultimenu_block_get_blocks_by_region($region) {
  $build = array();
  if ($blocks = block_get_blocks_by_region($region)) {
    $build = $blocks;
  }
  if (function_exists('context_get_plugin') && ($context = context_get_plugin('reaction', 'block'))) {
    if ($context_block_list = $context
      ->block_list($region)) {

      // Workaround the $context->block_get_blocks_by_region() issue.
      // Ref. https://drupal.org/node/966768
      $fixed_context_block_list = _block_render_blocks($context_block_list);
      $blocks_context = _block_get_renderable_array($fixed_context_block_list);
      $build = array_merge($blocks_context, $build);
    }
  }
  return $build;
}

/**
 * Add the active trail indicators into the tree.
 *
 * The data returned by menu_tree_page_data() has link['in_active_trail'] set to
 * TRUE for each menu item in the active trail. The data returned from
 * menu_tree_all_data() does not contain the active trail indicators. This is a
 * helper function that adds it back in.
 *
 * Function copy of menu_tree_add_active_path() from menu_block 7.x-2.3.
 *
 * @param $tree
 *   array The menu tree.
 * @return
 *   void
 */
function ultimenu_tree_add_active_path(&$tree) {

  // Grab any menu item to find the menu_name for this tree.
  $menu_item = current($tree);
  $tree_with_trail = menu_tree_page_data($menu_item['link']['menu_name']);

  // To traverse the original tree down the active trail, we use a pointer.
  $subtree_pointer =& $tree;

  // Find each key in the active trail.
  while ($tree_with_trail) {
    foreach ($tree_with_trail as $key => &$value) {
      if ($tree_with_trail[$key]['link']['in_active_trail']) {

        // Set the active trail info in the original tree.
        $subtree_pointer[$key]['link']['in_active_trail'] = TRUE;

        // Continue in the subtree, if it exists.
        $tree_with_trail =& $tree_with_trail[$key]['below'];
        $subtree_pointer =& $subtree_pointer[$key]['below'];
        break;
      }
      else {
        unset($tree_with_trail[$key]);
      }
    }
  }
}

Functions

Name	Description
ultimenu_blocks_enabled	Check for an Ultimenu block enabled by settings.
ultimenu_block_get_blocks_by_region	A helper function to generate a list of blocks from a specified region.
ultimenu_get_blocks	Collects enabled Ultimenu block items.
ultimenu_get_config	The configuration for the requested block delta.
ultimenu_get_menus	Get all available menus, excluding some admin menus.
ultimenu_get_settings	A wrapper function for variable_get.
ultimenu_get_skins	Retrieves stored CSS files for Ultimenu skins.
ultimenu_get_ultimenu_theme_info	Gets Ultimenu regions from the default theme .info.
ultimenu_regions	The array of available Ultimenu regions based on enabled menu items.
ultimenu_regions_enabled	Returns the array of enabled Ultimenu regions based on enabled settings.
ultimenu_remove_ultimenu_theme_info	Colllects unwanted Ultimenu regions for removal stored in the theme .info.
ultimenu_tree_add_active_path	Add the active trail indicators into the tree.
ultimenu_truncate_menu_property	Simplify menu names or menu item titles for region key.