class context_condition_menu in Context 6.3

Expose menu items as a context condition.

Hierarchy

• class \context_condition
  • class \context_condition_menu

2 string references to 'context_condition_menu'

_context_context_plugins in ./context.plugins.inc

Context plugins.

_context_context_registry in ./context.plugins.inc

Context registry.

File

plugins/context_condition_menu.inc, line 6

class context_condition_menu extends context_condition {

  /**
   * Override of condition_values().
   */
  function condition_values() {
    $menu_names = variable_get('context_condition_menu_selections', menu_get_menus());
    $menus = menu_parent_options(array_reverse($menu_names), NULL);
    $root_menus = array();
    foreach ($menus as $key => $name) {
      $id = explode(':', $key);
      if ($id[1] == '0') {
        $root_menus[$id[0]] = check_plain($name);
      }
      else {
        $link = menu_link_load($id[1]);
        $identifier = $link['link_path'];
        $root_menu = $root_menus[$id[0]];
        while (isset($menus[$root_menu][$identifier])) {
          $identifier .= "'";
        }
        $menus[$root_menu][$identifier] = $name;
      }
      unset($menus[$key]);
    }
    array_unshift($menus, "-- " . t('None') . " --");
    return $menus;
  }

  /**
   * Override of condition_form().
   * Use multiselect widget.
   */
  function condition_form($context) {
    $form = parent::condition_form($context);
    $form['#type'] = 'select';
    $form['#multiple'] = TRUE;
    return $form;
  }

  /**
   * Override of condition_form_submit().
   * Trim any identifier padding for non-unique path menu items.
   */
  function condition_form_submit($values) {

    // Trim any identifier padding for non-unique path menu items.
    $values = parent::condition_form_submit($values);
    $trimmed = array();
    foreach ($values as $key => $value) {
      $trimmed[trim($key, "'")] = trim($value, "'");
    }
    return $trimmed;
  }

  /**
   * Settings form for variables.
   */
  function settings_form() {

    // Get the list of menus in the system.
    $menus = array_values(menu_get_menus());

    // Convert the list to the format menu_name => menu_name.
    $options = array_combine($menus, $menus);
    $form = array();
    $form['context_condition_menu_selections'] = array(
      '#title' => t('Menus'),
      '#type' => 'select',
      '#multiple' => TRUE,
      '#options' => $options,
      '#required' => TRUE,
      '#default_value' => variable_get('context_condition_menu_selections', $options),
      '#description' => t('Select one or more Drupal menus to use during Menu Context condition checks. If none are selected, all of the menus are used.'),
    );
    return $form;
  }

  /**
   * Override of execute().
   */
  function execute() {
    if ($this
      ->condition_used()) {

      // Menu trail condition integration. Note that because of the way
      // menu_get_active_trail() is written this will often not work for active
      // menu items outside the standard navigation tree without the additional
      // helper code below.
      if (menu_get_active_menu_name() === 'navigation') {
        $item = menu_get_item();
        $menus = variable_get('context_condition_menu_selections', menu_get_menus());
        $params = array_values($menus);
        $params[] = $item['href'];
        $in_clause = implode(', ', array_fill(0, count($menus), "'%s'"));
        $query = "SELECT menu_name FROM {menu_links} WHERE menu_name IN ({$in_clause}) AND link_path = '%s' ORDER BY mlid ASC";
        if ($menu_name = db_result(db_query($query, $params))) {
          menu_set_active_menu_name($menu_name);
        }
      }
      $trail = menu_get_active_trail();
      foreach ($trail as $item) {
        if (!empty($item['href'])) {
          foreach ($this
            ->get_contexts($item['href']) as $context) {
            $this
              ->condition_met($context, $item['href']);
          }
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
context_condition::$description		property
context_condition::$plugin		property
context_condition::$title		property
context_condition::$values		property
context_condition::condition_met		function	Marks a context as having met this particular condition.
context_condition::condition_used		function	Check whether this condition is used by any contexts. Can be used to prevent expensive condition checks from being triggered when no contexts use this condition.
context_condition::editor_form		function	Context editor form for conditions.	1
context_condition::editor_form_submit		function	Context editor form submit handler.
context_condition::fetch_from_context		function	Retrieve options from the context provided.
context_condition::get_contexts		function	Retrieve all contexts with the condition value provided.
context_condition::options_form		function	Options form. Provide additional options for your condition.	2
context_condition::options_form_submit		function	Options form submit handler.
context_condition::__clone		function	Clone our references when we're being cloned.
context_condition::__construct		function	Constructor. Do not override.
context_condition_menu::condition_form		function	Override of condition_form(). Use multiselect widget. Overrides context_condition::condition_form
context_condition_menu::condition_form_submit		function	Override of condition_form_submit(). Trim any identifier padding for non-unique path menu items. Overrides context_condition::condition_form_submit
context_condition_menu::condition_values		function	Override of condition_values(). Overrides context_condition::condition_values
context_condition_menu::execute		function	Override of execute().
context_condition_menu::settings_form		function	Settings form for variables. Overrides context_condition::settings_form