diff --git a/taxonomy_menu.module b/taxonomy_menu.module index 87cd626..1014e98 100644 --- a/taxonomy_menu.module +++ b/taxonomy_menu.module @@ -70,8 +70,8 @@ function taxonomy_menu_form_alter(&$form, &$form_state, $form_id) { ); //get taxonomy menu form options - //$form['taxonomy_menu']['options'] = _taxonomy_menu_create_options($form['vid']['#value']); - // + $form['taxonomy_menu']['options'] = _taxonomy_menu_create_options($form['vid']['#value']); + //rebuild the menu $form['taxonomy_menu']['options']['rebuild'] = array( '#type' => 'checkbox', @@ -88,6 +88,12 @@ function taxonomy_menu_form_alter(&$form, &$form_state, $form_id) { $form['#submit'][] = 'taxonomy_menu_vocab_submit'; } + elseif ($form_id == "taxonomy_overview_terms") { + // add an extra submit handler to sync the rearranged terms with menu + // @ TODO: using hook_taxonomy_vocabulary_update is nicer then callback, but gives less info and + // does not always fire. + $form['#submit'][] = 'taxonomy_menu_overview_submit'; + } } /** @@ -179,6 +185,55 @@ function taxonomy_menu_vocab_submit($form, &$form_state) { } /** + * Submit handler, reacting on form ID: taxonomy_overview_terms + */ +function taxonomy_menu_overview_submit(&$form, &$form_state) { + // Only sync if taxonomy_menu is enabled for this vocab and the 'sync' + // option has been checked. + + // This form has the following flow of buttons: + // 1. [Save] --> rebuild taxonomy_menu + // 2. [Reset to alphabetical] --> no rebuild yet + // 3. [Reset to alphabetical][Reset to alphabetical] --> rebuild + // 4. [Reset to alphabetical][Cancel] --> no rebuild + // The code below avoids rebuilding after situation 2. + + if ($form_state['rebuild'] == FALSE && isset($form['#vocabulary']->vid) ) { + // Try to catch the 'Save' button. + $vid = $form['#vocabulary']->vid; + } + elseif ($form_state['rebuild'] == TRUE && isset($form['#vocabulary']->vid) ) { + // Try to catch the 'Reset to alphabetical' button + $vid = NULL; + } + elseif ($form_state['rebuild'] == FALSE && isset($form['vid']['#value']) ) { + // Try to catch the second (confirming) 'Reset to alphabetical' button. + $vid = $form['vid']['#value']; + } + else { + // The button [Reset to alphabetical] [Cancel] does not call this page. + $vid = NULL; + } + + if (isset($vid)) { + $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $vid), 0); + $sync = variable_get(_taxonomy_menu_build_variable('sync', $vid), 0); + if ($menu_name && $sync) { + // Update all menu items (do not rebuild the menu). + $message = _taxonomy_menu_update_link_items($vid); + + // Report status. + if (isset($message)) { + drupal_set_message($message, 'status'); + } + + // Rebuild the menu. + menu_cache_clear($menu_name); + } + } +} + +/** * rebuilds a menu * * @param $vid @@ -188,6 +243,7 @@ function taxonomy_menu_vocab_submit($form, &$form_state) { function _taxonomy_menu_rebuild($vid) { // Remove all of the menu items for this vocabulary _taxonomy_menu_delete_all($vid); + // Only insert the links if a menu is set if (variable_get(_taxonomy_menu_build_variable('vocab_menu', $vid), FALSE)) { _taxonomy_menu_insert_link_items($vid); @@ -222,24 +278,27 @@ function _taxonomy_menu_check_variable($variable, $new_value) { */ function _taxonomy_menu_update_link_items($vid) { $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $vid), FALSE); - - //get a list of the current menu links + // Get a list of the current tid - menu_link combinations $menu_links = _taxonomy_menu_get_menu_items($vid); - //cycle through the + // Cycle through the menu links foreach ($menu_links as $tid => $mlid) { if ($tid == 0) { - $args['vid'] = $vid; + $args = array( + 'vid' => $vid, + 'menu_name' => $menu_name, + 'mlid' => $mlid, + ); } else { - $args['term'] = taxonomy_term_load($tid); - //since taxonomy_get_term does not return the parents, fetch them now - $args['term']->parents = _taxonomy_menu_get_parents($tid); - } + $term = taxonomy_term_load($tid); - //set the menu name - $args['menu_name'] = $menu_name; - $args['mlid'] = $mlid; + $args = array( + 'term' => $term, + 'menu_name' => $menu_name, + 'mlid' => $mlid, + ); + } //update the menu link taxonomy_menu_handler('update', $args); @@ -254,12 +313,11 @@ function _taxonomy_menu_update_link_items($vid) { * @param $vid */ function _taxonomy_menu_insert_link_items($vid) { - $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $vid), FALSE); // Check to see if we should had a vocab item if (variable_get(_taxonomy_menu_build_variable('voc_item', $vid), FALSE)) { $args = array( 'vid' => $vid, - 'menu_name' => $menu_name, + 'menu_name' => variable_get(_taxonomy_menu_build_variable('vocab_menu', $vid), FALSE), ); $mlid = taxonomy_menu_handler('insert', $args); } @@ -278,87 +336,32 @@ function taxonomy_menu_taxonomy_vocabulary_delete($vocabulary) { } /** + * Implementation of hook_taxonomy_vocabulary_update(). + */ +// @ TODO: using hook_taxonomy_vocabulary_update is nicer then callback, but gives less info and +// does not always fire. +//function taxonomy_menu_taxonomy_vocabulary_update($vocabulary) { +//} + +/** * Implementation of hook_taxonomy_term_insert($term). */ function taxonomy_menu_taxonomy_term_insert($term) { - // only sync if taxonomy_menu is enabled for this vocab and the 'sync' - // option has been checked. - $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $term->vid), 0); - $sync = variable_get(_taxonomy_menu_build_variable('sync', $term->vid), 0); - - if ($menu_name && $sync) { - //we have to pull from the args because using a taxonomy function pulls from the cache - $item = array( - 'term' => $term, - 'menu_name' => $menu_name, - ); - $message = t('Term %term has been added to taxonomy menu %menu_name.', array('%term' => $term->name, '%menu_name' => $menu_name)); - - // Run function. - taxonomy_menu_handler('insert', $item); - // Report status. - drupal_set_message($message, 'status'); - - // Rebuild the menu. - menu_cache_clear($menu_name); - } + _taxonomy_menu_taxonomy_termapi_helper($term, 'insert'); } /** * Implementation of hook_taxonomy_term_update(). */ -function taxonomy_menu_taxonomy_menu_term_update($term) { - // Only sync if taxonomy_menu is enabled for this vocab and the 'sync' - // option has been checked. - $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $term->vid), 0); - $sync = variable_get(_taxonomy_menu_build_variable('sync', $term->vid), 0); - - if ($menu_name && $sync) { - $item = array( - 'term' => $term, - 'menu_name' => $menu_name, - 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), - ); - $message = t('Term %term has been updated in taxonomy menu %menu_name.', array('%term' => $term->name, '%menu_name' => $menu_name)); - break; - - // run function - taxonomy_menu_handler('update', $item); - // report status - drupal_set_message($message, 'status'); - - // rebuild the menu - menu_cache_clear($menu_name); - } +function taxonomy_menu_taxonomy_term_update($term) { + _taxonomy_menu_taxonomy_termapi_helper($term, 'update'); } /** * Implementation of hook_taxonomy_term_delete() */ function taxonomy_menu_taxonomy_term_delete($term) { - // only sync if taxonomy_menu is enabled for this vocab and the 'sync' - // option has been checked. - $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $term->vid), 0); - $sync = variable_get(_taxonomy_menu_build_variable('sync', $term->vid), 0); - - if ($menu_name && $sync) { - $item = array( - 'tid' => $term->tid, - 'vid' => $term->vid, - 'menu_name' => $menu_name, - 'term' => $term, - 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), - ); - $message = t('Term %term has been deleted from taxonomy menu %menu_name.', array('%term' => $term->name, '%menu_name' => $menu_name)); - - // run function - taxonomy_menu_handler('delete', $item); - // report status - drupal_set_message($message, 'status'); - - // rebuild the menu - menu_cache_clear($menu_name); - } + _taxonomy_menu_taxonomy_termapi_helper($term, 'delete'); } /** @@ -413,66 +416,82 @@ function taxonomy_menu_node_delete($node) { } /** - * Helper function to + * Abstraction of hook_taxonomy_term_() + */ +function _taxonomy_menu_taxonomy_termapi_helper($term, $operation) { + // Only sync if taxonomy_menu is enabled for this vocab and the 'sync' + // option has been checked. + $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $term->vid), 0); + $sync = variable_get(_taxonomy_menu_build_variable('sync', $term->vid), 0); + + if ($menu_name && $sync) { + $item = array( + 'tid' => $term->tid, + 'vid' => $term->vid, + 'term' => $term, + 'menu_name' => $menu_name, + 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), + ); + + switch ($operation) { + case 'insert': + $text = 'Added term %term to taxonomy menu %menu_name.'; + break; + case 'update': + $text = 'Updated term %term in taxonomy menu %menu_name.'; + break; + case 'delete': + $text = 'Deleted term %term from taxonomy menu %menu_name.'; + break; + } + $message = t($text, array('%term' => $term->name, '%menu_name' => $menu_name)); + + // run function + taxonomy_menu_handler($operation, $item); + + // report status + drupal_set_message($message, 'status'); + + // rebuild the menu + menu_cache_clear($menu_name); + } +} + +/** + * Helper function for hook_node_insert/update/delete * @param $tids * @param $node * @return unknown_type */ function _taxonomy_menu_nodeapi_helper($op, $terms = array(), $node) { foreach ($terms as $key => $tid) { - $term = taxonomy_term_load($tid); - $term->parents = array_keys(taxonomy_get_parents($tid)); - //$parents = taxonomy_get_parents($tid); - //foreach ($parents as $term_id => $term_obj) { - // $term->parents[] = $term_id; - //} //update the menu for each term if necessary + + $term = taxonomy_term_load($tid); + $menu_name = variable_get(_taxonomy_menu_build_variable('vocab_menu', $term->vid), FALSE); $vocb_sync = variable_get(_taxonomy_menu_build_variable('sync', $term->vid), TRUE); $menu_num = variable_get(_taxonomy_menu_build_variable('display_num', $term->vid), TRUE); $hide_empty = variable_get(_taxonomy_menu_build_variable('hide_empty_terms', $term->vid), FALSE); if ($menu_name && $vocb_sync && ($menu_num || $hide_empty)) { - switch ($op) { - case 'update': - //build argument array to save menu_item - $args = array( - 'tid' => $term->tid, - 'vid' => $term->vid, - 'term' => $term, - 'menu_name' => $menu_name, - 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), - ); - //since taxonomy_get_term does not return the parents, fetch them now - $args['term']->parents = _taxonomy_menu_get_parents($term->tid); - break; - - case 'insert': - //build argument array to save menu_item - $args = array( - 'tid' => $term->tid, - 'vid' => $term->vid, - 'term' => $term, - 'menu_name' => $menu_name, - 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), - ); - //since taxonomy_get_term does not return the parents, fetch them now - $args['term']->parents = _taxonomy_menu_get_parents($term->tid); - break; - - case 'delete': - $args = array( - 'term' => $term, - 'tid' => $term->tid, - 'vid' => $term->vid, - 'menu_name' => $menu_name, - 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), - ); + + //build argument array to save menu_item + $args = array( + 'tid' => $term->tid, + 'vid' => $term->vid, + 'term' => $term, + 'menu_name' => $menu_name, + 'mlid' => _taxonomy_menu_get_mlid($term->tid, $term->vid), + ); + + if ($op == 'delete') { /* Turn the op to 'update' here since we really do want to update the item * and not delete/recreate it, since the latter will break hierarchy and * customizations. */ $op = 'update'; } + taxonomy_menu_handler($op, $args, $node); } } @@ -528,6 +547,7 @@ function taxonomy_menu_handler($op, $args = array(), $node = NULL, $item = array * standard taxonomy $term object. This is because this function is also * called from hook_taxonomy(), which doesn't have a $term object. Rather * have one consistent method of passing the data. + * @TODO: Update this docu: hook_taxonomy() does not exist in D7 * * @param $item * array with the following key/value pairs: @@ -578,7 +598,8 @@ function _taxonomy_menu_save($item) { if (strpos($split[1], '?') !== FALSE) { // the query split didn't work, too many question marks // error? - } else { + } + else { $link['options']['query'] = $split[1]; $link['link_path'] = $split[0]; } @@ -615,6 +636,7 @@ function _taxonomy_menu_save($item) { if (isset($item['remove']) && $item['remove']) { $link['hidden'] = 1; } + // Save the menu item if ($mlid = menu_link_save($link)) { //if inserting a new menu item then insert a record into the table @@ -696,7 +718,7 @@ function taxonomy_menu_path_default($vid, $tid) { } if ($tids) { $end = implode(' ', $tids); - $path .= ' '. $end; + $path .= ' ' . $end; } } } @@ -737,9 +759,7 @@ function taxonomy_menu_taxonomy_menu_delete(&$item) { * The node object. */ function _taxonomy_menu_create_item($args = array(), $node) { - - //if tid = 0 then we are creating a vocab item - + // If tid = 0 then we are creating a vocab item if (isset($args['tid']) && isset($args['vid']) && $args['tid'] == 0 && variable_get(_taxonomy_menu_build_variable('voc_item', $args['vid']), 0)) { $vocab = taxonomy_vocabulary_load($args['vid']); $item = array( @@ -753,42 +773,41 @@ function _taxonomy_menu_create_item($args = array(), $node) { 'language' => $vocab->language, ); - return $item; } else { + // If tid <> 0 then we are creating a term item $term = $args['term']; - } - // get the first parent - if (is_array($term->parents)) { - foreach ($term->parents as $key => $val) { - $ptid = $val; - break; + // Sometimes $term->parents is not set so we find it. + if (!isset($term->parents)) { + $term->parents = _taxonomy_menu_get_parents($term->tid); + if (empty($term->parents)) { + // even without parents, create one with $ptid = 0 + $term->parents = array ( 0 => '0'); + } } - } - else { - $ptid = $term->parents; - } - //if ptid is empty, then set it to 0 - if (empty($ptid)) { - $ptid = 0; - } - - // turn the term into the correct $item array form - $item = array( - 'tid' => $term->tid, - 'name' => $term->name, - 'description' => $term->description, - 'weight' => $term->weight, - 'vid' => $term->vid, - 'ptid' => $ptid, - 'menu_name' => $args['menu_name'], - 'language' => isset($term->language) ? $term->language : ($node ? $node->language : $GLOBALS['language']->language), - ); + foreach ($term->parents as $parent) { + $ptid = $parent; + // turn the term into the correct $item array form + $item = array( + 'tid' => $term->tid, + 'vid' => $term->vid, + 'menu_name' => $args['menu_name'], + 'name' => $term->name, + 'description' => $term->description, + 'weight' => $term->weight, + 'ptid' => $ptid, + 'language' => isset($term->language) ? $term->language : ($node ? $node->language : $GLOBALS['language']->language), + ); + if (isset($args['mlid'])) { + $item['mlid'] = $args['mlid']; + } - if (isset($args['mlid'])) { - $item['mlid'] = $args['mlid']; + // Mutiple parents are not supported yet, hence this break. + // without the break, the item is inserted multiple under one parent, instead once under each parent. + break; + } } return $item; @@ -844,9 +863,10 @@ function _taxonomy_menu_item($item) { } $item['name'] .= " ($num)"; }*/ - } elseif ($item['tid'] == 0) { + } + elseif ($item['tid'] == 0) { //if custom name is provided, use that name - $custom_name = variable_get(_taxonomy_menu_build_variable('voc_name',$item['vid']), ''); + $custom_name = variable_get(_taxonomy_menu_build_variable('voc_name', $item['vid']), ''); if (!empty($custom_name)) { $item['name'] = $custom_name; } @@ -917,10 +937,10 @@ function _taxonomy_menu_create_options($vid) { $options[$field_name]['#type'] = 'checkbox'; } - //set the option feildset values - $options['#type'] = 'fieldset'; - $options['#title'] = t('Options'); - $options['#collapsible'] = TRUE; +// //set the option fieldset values +// $options['#type'] = 'fieldset'; +// $options['#title'] = t('Options'); +// $options['#collapsible'] = TRUE; //remove the default value from the array so we don't pass it to the form unset($options[$field_name]['default']); @@ -952,6 +972,7 @@ function taxonomy_menu_taxonomy_menu_options() { 'default' => TRUE, ); +/* $options['display_num'] = array( '#title' => t('Display number of items'), '#description' => t('Display the number of items per taxonomy terms. Will not show up for vocabulary menu items.'), @@ -995,7 +1016,7 @@ function taxonomy_menu_taxonomy_menu_options() { 'default' => FALSE, '#description' => t('This changes tid+tid+tid to "All" in term when Display descendants has been selected.
Only used if Menu path type is "Default path".
Works with default taxonomy page.'), ); - +*/ return $options; } @@ -1037,14 +1058,14 @@ function taxonomy_menu_translated_menu_link_alter(&$item, $map) { if ($item['title'] != ($term->name . $display_num)) { // Should not happen - watchdog('error', t('Menu and taxonomy name mismatch: @title != @name', array('@title' => $item['title'], '@name' => $term->name . $display_num))); + watchdog('error', 'Menu and taxonomy name mismatch: @title != @name', array('@title' => $item['title'], '@name' => $term->name . $display_num)); } $item['title'] = $item['link_title'] = i18n_taxonomy_term_name($term) . $display_num; } // is a vocabulary else { $vocab = taxonomy_vocabulary_load($t->vid); - $item['title'] = i18n_string('taxonomy:vocabulary:'. $vocab->vid .':name', $vocab->name); + $item['title'] = i18n_string('taxonomy:vocabulary:' . $vocab->vid . ':name', $vocab->name); } } }