i18n/i18nmenu/i18nmenu.module

<?php
// $Id: i18nmenu.module,v 1.1 2007/10/22 12:33:50 jareyero Exp $

/**
 * Internationalization (i18n) submodule: Menu translation
 *
 * @author Jose A. Reyero, 2005
 *
 */

/**
 * Implementation of hook_locale().
 */
function i18nmenu_locale($op = 'groups') {
  switch ($op) {
    case 'groups':
      return array('menu' => t('Menu'));
  }
}
/**
 * Implementation of hook_menu_alter().
 */
function i18nmenu_menu_alter(&$items){
  //dsm($items);
}

/**
 * Implementation of hook_menu_link_alter().
 * 
 * Catch changed links, update language and refresh texts
 */
function i18nmenu_menu_link_alter(&$item, $menu) {
  // If we set option to language it causes an error with the link system
  // This should handle language only as the links are being manually updated
  if (!empty($item['language'])) {
    //dsm("Language set");
    $item['options']['langcode'] = $item['language'];
  } elseif(isset($item['language'])) {
    //dsm('Removed language');
    unset($item['options']['langcode']);
  }
  // @ TO DO: Refresh texts
  //dsm($item);
  //$original = $item['original_item'];
  //$item['router_path'] = _menu_find_router_path($menu, $item['link_path']);
  //i18nmenu_make_translatable($item);
}

function i18nmenu_help($section, $arg) {
  switch ($section) {
    case 'admin/help#i18nmenu' :
      $output = '<p>'.t('This module provides support for translatable custom menu items:').'</p>';
      $output .= '<ul>';
      $output .= '<li>'.t('Create menus as usual, with names in English or the default language. If the menu is already created, no changes are needed.').'</li>';
      $output .= '<li>'.t('Use the localization system to translate menu item strings').'</li>';
      $output .= '<li>'.t('Instead of the old menus use the new blocks provided by the module. These will be localized.').'</li>';
      $output .= '<li>'.t('Optionally, you can set up a language for a menu item so it is only displayed for that language.').'</li>';
      $output .= '</ul>';
      return $output;
  }
}

/**
 * Implementation of hook_block().
 */
function i18nmenu_block($op = 'list', $delta = 0) {
  global $user;
  $menus = menu_get_menus();
  
  // unset($menus['navigation']);
  if ($op == 'list') {
    $blocks = array();
    foreach ($menus as $name => $title) {
      // Default "Navigation" block is handled by user.module.
      $blocks[$name]['info'] = check_plain($title).t('[Translated]');
      // Menu blocks can't be cached because each menu item can have
      // a custom access callback. menu.inc manages its own caching.
      $blocks[$name]['cache'] = BLOCK_NO_CACHE;
    }
    return $blocks;
  }
  else if ($op == 'view') {
    // The Navigation menu is handled like in the user module.
    if ($delta == 'navigation') {
      $data['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
    } else {
      $data['subject'] = check_plain($menus[$delta]);
    }
    $data['content'] = i18nmenu_translated_tree($delta);
    return $data;
  }  
}

/**
 * Get localized menu tree
 */
function i18nmenu_translated_tree($menu_name) {
  static $menu_output = array();

  if (!isset($menu_output[$menu_name])) {
    $tree = menu_tree_page_data($menu_name);
    i18nmenu_localize_tree($tree);
    $menu_output[$menu_name] = menu_tree_output($tree);
  }
  return $menu_output[$menu_name];
}

/**
 * Localize menu tree
 */
function i18nmenu_localize_tree(&$tree) {
  global $language;
  foreach($tree as $index => $item) {
    $link = $item['link'];
    if ($link['customized']) {
      // Remove links for other languages than current
      // Links with language wont be localized
      if (!empty($link['options']['langcode'])) {
        if($link['options']['langcode'] != $language->language) {
          unset($tree[$index]);
          //dsm("Removed because language:".$link['title'].' language='.$link['options']['langcode']);
        }
      } else {
        $router = i18nmenu_get_router($link['router_path']);
        // If the title is the same it will be localized by the menu system
        if ($link['link_title'] != $router['title']){
          //$tree[$index]['link']['title'] = 'Translated';
          $tree[$index]['link']['title'] = tt('menu:item:'.$link['mlid'].':title', $link['link_title'], NULL, TRUE);
        }
      }
    }
  }
}

/**
 * Get the menu router for this router path
 * 
 * We need the untranslated title to comparte, and this will be fast
 * There's no api function to do this?
 */
function i18nmenu_get_router($path) {
  static $cache = array();
  if (!array_key_exists($path, $cache)) {
    $cache[$path] = db_fetch_array(db_query("SELECT title FROM {menu_router} WHERE path = '%s'", $path));
  }
  return $cache[$path];
}

/**
 * Implementation of hook_form_alter().
 */
function i18nmenu_form_alter(&$form, $form_state, $form_id){
  if ($form_id == 'menu_edit_item') {
    //dsm ($form);
    if ($form['menu']['#item'] && isset($form['menu']['#item']['options']['langcode'])) {
      $language = $form['menu']['#item']['options']['langcode'];
    } else {
      $language = '';
    }
    $form['menu']['language'] = array(
      '#type' => 'select',
      '#title' => t('Language'),
      '#options' => array('' => t('All languages')) + locale_language_list('name'),
      '#default_value' => $language,
    );
  }
}
1	<?php
2	// $Id: i18nmenu.module,v 1.1 2007/10/22 12:33:50 jareyero Exp $
3
4	/**
5	* Internationalization (i18n) submodule: Menu translation
6	*
7	* @author Jose A. Reyero, 2005
8	*
9	*/
10
11	/**
12	* Implementation of hook_locale().
13	*/
14	function i18nmenu_locale($op = 'groups') {
15	switch ($op) {
16	case 'groups':
17	return array('menu' => t('Menu'));
18	}
19	}
20	/**
21	* Implementation of hook_menu_alter().
22	*/
23	function i18nmenu_menu_alter(&$items){
24	//dsm($items);
25	}
26
27	/**
28	* Implementation of hook_menu_link_alter().
29	*
30	* Catch changed links, update language and refresh texts
31	*/
32	function i18nmenu_menu_link_alter(&$item, $menu) {
33	// If we set option to language it causes an error with the link system
34	// This should handle language only as the links are being manually updated
35	if (!empty($item['language'])) {
36	//dsm("Language set");
37	$item['options']['langcode'] = $item['language'];
38	} elseif(isset($item['language'])) {
39	//dsm('Removed language');
40	unset($item['options']['langcode']);
41	}
42	// @ TO DO: Refresh texts
43	//dsm($item);
44	//$original = $item['original_item'];
45	//$item['router_path'] = _menu_find_router_path($menu, $item['link_path']);
46	//i18nmenu_make_translatable($item);
47	}
48
49	function i18nmenu_help($section, $arg) {
50	switch ($section) {
51	case 'admin/help#i18nmenu' :
52	$output = '<p>'.t('This module provides support for translatable custom menu items:').'</p>';
53	$output .= '<ul>';
54	$output .= '<li>'.t('Create menus as usual, with names in English or the default language. If the menu is already created, no changes are needed.').'</li>';
55	$output .= '<li>'.t('Use the localization system to translate menu item strings').'</li>';
56	$output .= '<li>'.t('Instead of the old menus use the new blocks provided by the module. These will be localized.').'</li>';
57	$output .= '<li>'.t('Optionally, you can set up a language for a menu item so it is only displayed for that language.').'</li>';
58	$output .= '</ul>';
59	return $output;
60	}
61	}
62
63	/**
64	* Implementation of hook_block().
65	*/
66	function i18nmenu_block($op = 'list', $delta = 0) {
67	global $user;
68	$menus = menu_get_menus();
69
70	// unset($menus['navigation']);
71	if ($op == 'list') {
72	$blocks = array();
73	foreach ($menus as $name => $title) {
74	// Default "Navigation" block is handled by user.module.
75	$blocks[$name]['info'] = check_plain($title).t('[Translated]');
76	// Menu blocks can't be cached because each menu item can have
77	// a custom access callback. menu.inc manages its own caching.
78	$blocks[$name]['cache'] = BLOCK_NO_CACHE;
79	}
80	return $blocks;
81	}
82	else if ($op == 'view') {
83	// The Navigation menu is handled like in the user module.
84	if ($delta == 'navigation') {
85	$data['subject'] = $user->uid ? check_plain($user->name) : t('Navigation');
86	} else {
87	$data['subject'] = check_plain($menus[$delta]);
88	}
89	$data['content'] = i18nmenu_translated_tree($delta);
90	return $data;
91	}
92	}
93
94	/**
95	* Get localized menu tree
96	*/
97	function i18nmenu_translated_tree($menu_name) {
98	static $menu_output = array();
99
100	if (!isset($menu_output[$menu_name])) {
101	$tree = menu_tree_page_data($menu_name);
102	i18nmenu_localize_tree($tree);
103	$menu_output[$menu_name] = menu_tree_output($tree);
104	}
105	return $menu_output[$menu_name];
106	}
107
108	/**
109	* Localize menu tree
110	*/
111	function i18nmenu_localize_tree(&$tree) {
112	global $language;
113	foreach($tree as $index => $item) {
114	$link = $item['link'];
115	if ($link['customized']) {
116	// Remove links for other languages than current
117	// Links with language wont be localized
118	if (!empty($link['options']['langcode'])) {
119	if($link['options']['langcode'] != $language->language) {
120	unset($tree[$index]);
121	//dsm("Removed because language:".$link['title'].' language='.$link['options']['langcode']);
122	}
123	} else {
124	$router = i18nmenu_get_router($link['router_path']);
125	// If the title is the same it will be localized by the menu system
126	if ($link['link_title'] != $router['title']){
127	//$tree[$index]['link']['title'] = 'Translated';
128	$tree[$index]['link']['title'] = tt('menu:item:'.$link['mlid'].':title', $link['link_title'], NULL, TRUE);
129	}
130	}
131	}
132	}
133	}
134
135	/**
136	* Get the menu router for this router path
137	*
138	* We need the untranslated title to comparte, and this will be fast
139	* There's no api function to do this?
140	*/
141	function i18nmenu_get_router($path) {
142	static $cache = array();
143	if (!array_key_exists($path, $cache)) {
144	$cache[$path] = db_fetch_array(db_query("SELECT title FROM {menu_router} WHERE path = '%s'", $path));
145	}
146	return $cache[$path];
147	}
148
149	/**
150	* Implementation of hook_form_alter().
151	*/
152	function i18nmenu_form_alter(&$form, $form_state, $form_id){
153	if ($form_id == 'menu_edit_item') {
154	//dsm ($form);
155	if ($form['menu']['#item'] && isset($form['menu']['#item']['options']['langcode'])) {
156	$language = $form['menu']['#item']['options']['langcode'];
157	} else {
158	$language = '';
159	}
160	$form['menu']['language'] = array(
161	'#type' => 'select',
162	'#title' => t('Language'),
163	'#options' => array('' => t('All languages')) + locale_language_list('name'),
164	'#default_value' => $language,
165	);
166	}
167	}