[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/modules/locale/ -> locale.module (source)

   1  <?php
   2  // $Id: locale.module,v 1.212.2.11 2010/12/06 06:50:56 goba Exp $
   3  
   4  /**
   5   * @file
   6   *   Add language handling functionality and enables the translation of the
   7   *   user interface to languages other than English.
   8   *
   9   *   When enabled, multiple languages can be set up. The site interface
  10   *   can be displayed in different languages, as well as nodes can have languages
  11   *   assigned. The setup of languages and translations is completely web based.
  12   *   Gettext portable object files are supported.
  13   */
  14  
  15  // ---------------------------------------------------------------------------------
  16  // Hook implementations
  17  
  18  /**
  19   * Implementation of hook_help().
  20   */
  21  function locale_help($path, $arg) {
  22    switch ($path) {
  23      case 'admin/help#locale':
  24        $output = '<p>'. t('The locale module allows your Drupal site to be presented in languages other than the default English, a defining feature of multi-lingual websites. The locale module works by examining text as it is about to be displayed: when a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for later review by a translator.') .'</p>';
  25        $output .= '<p>'. t('Beyond translation of the Drupal interface, the locale module provides a feature set tailored to the needs of a multi-lingual site. Language negotiation allows your site to automatically change language based on the domain or path used for each request. Users may (optionally) select their preferred language on their <em>My account</em> page, and your site can be configured to honor a web browser\'s preferred language settings. Your site content can be created in (and translated to) any enabled language, and each post may have a language-appropriate alias for each of its translations. The locale module works in concert with the <a href="@content-help">content translation module</a> to manage translated content.', array('@content-help' => url('admin/help/translation'))) .'</p>';
  26        $output .= '<p>'. t('Translations may be provided by:') .'</p>';
  27        $output .= '<ul><li>'. t("translating the original text via the locale module's integrated web interface, or") .'</li>';
  28        $output .= '<li>'. t('importing files from a set of existing translations, known as a translation package. A translation package enables the display of a specific version of Drupal in a specific language, and contain files in the Gettext Portable Object (<em>.po</em>) format. Although not all languages are available for every version of Drupal, translation packages for many languages are available for download from the <a href="@translations">Drupal translation page</a>.', array('@translations' => 'http://localize.drupal.org')) .'</li></ul>';
  29        $output .= '<p>'. t('If an existing translation package does not meet your needs, the Gettext Portable Object (<em>.po</em>) files within a package may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The locale module\'s <a href="@import">import</a> feature allows the translated strings from a new or modified <em>.po</em> file to be added to your site. The locale module\'s <a href="@export">export</a> feature generates files from your site\'s translated strings, that can either be shared with others or edited offline by a Gettext translation editor.', array('@import' => url('admin/build/translate/import'), '@export' => url('admin/build/translate/export'))) .'</p>';
  30        $output .= '<p>'. t('For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/handbook/modules/locale/')) .'</p>';
  31        return $output;
  32      case 'admin/settings/language':
  33        $output = '<p>'. t("This page provides an overview of your site's enabled languages. If multiple languages are available and enabled, the text on your site interface may be translated, registered users may select their preferred language on the <em>My account</em> page, and site authors may indicate a specific language when creating posts. The site's default language is used for anonymous visitors and for users who have not selected a preferred language.") .'</p>';
  34        $output .= '<p>'. t('For each language available on the site, use the <em>edit</em> link to configure language details, including name, an optional language-specific path or domain, and whether the language is natively presented either left-to-right or right-to-left. These languages also appear in the <em>Language</em> selection when creating a post of a content type with multilingual support.') .'</p>';
  35        $output .= '<p>'. t('Use the <a href="@add-language">add language page</a> to enable additional languages (and automatically import files from a translation package, if available), the <a href="@search">translate interface page</a> to locate strings for manual translation, or the <a href="@import">import page</a> to add translations from individual <em>.po</em> files. A number of contributed translation packages containing <em>.po</em> files are available on the <a href="@translations">Drupal.org translations page</a>.', array('@add-language' => url('admin/settings/language/add'), '@search' => url('admin/build/translate/search'), '@import' => url('admin/build/translate/import'), '@translations' => 'http://localize.drupal.org')) .'</p>';
  36        return $output;
  37      case 'admin/settings/language/add':
  38        return '<p>'. t('Add all languages to be supported by your site. If your desired language is not available in the <em>Language name</em> drop-down, click <em>Custom language</em> and provide a language code and other details manually. When providing a language code manually, be sure to enter a standardized language code, since this code may be used by browsers to determine an appropriate display language.') .'</p>';
  39      case 'admin/settings/language/configure':
  40        $output = '<p>'. t("Language negotiation settings determine the site's presentation language. Available options include:") .'</p>';
  41        $output .= '<ul><li>'. t('<strong>None.</strong> The default language is used for site presentation, though users may (optionally) select a preferred language on the <em>My Account</em> page. (User language preferences will be used for site e-mails, if available.)') .'</li>';
  42        $output .= '<li>'. t('<strong>Path prefix only.</strong> The presentation language is determined by examining the path for a language code or other custom string that matches the path prefix (if any) specified for each language. If a suitable prefix is not identified, the default language is used. <em>Example: "example.com/de/contact" sets presentation language to German based on the use of "de" within the path.</em>') .'</li>';
  43        $output .= '<li>'. t("<strong>Path prefix with language fallback.</strong> The presentation language is determined by examining the path for a language code or other custom string that matches the path prefix (if any) specified for each language. If a suitable prefix is not identified, the display language is determined by the user's language preferences from the <em>My Account</em> page, or by the browser's language settings. If a presentation language cannot be determined, the default language is used.") .'</li>';
  44        $output .= '<li>'. t('<strong>Domain name only.</strong> The presentation language is determined by examining the domain used to access the site, and comparing it to the language domain (if any) specified for each language. If a match is not identified, the default language is used. <em>Example: "http://de.example.com/contact" sets presentation language to German based on the use of "http://de.example.com" in the domain.</em>') .'</li></ul>';
  45        $output .= '<p>'. t('The path prefix or domain name for a language may be set by editing the <a href="@languages">available languages</a>. In the absence of an appropriate match, the site is displayed in the <a href="@languages">default language</a>.', array('@languages' => url('admin/settings/language'))) .'</p>';
  46        return $output;
  47      case 'admin/build/translate':
  48        $output = '<p>'. t('This page provides an overview of available translatable strings. Drupal displays translatable strings in text groups; modules may define additional text groups containing other translatable strings. Because text groups provide a method of grouping related strings, they are often used to focus translation efforts on specific areas of the Drupal interface.') .'</p>';
  49        $output .= '<p>'. t('Review the <a href="@languages">languages page</a> for more information on adding support for additional languages.', array('@languages' => url('admin/settings/language'))) .'</p>';
  50        return $output;
  51      case 'admin/build/translate/import':
  52        $output = '<p>'. t('This page imports the translated strings contained in an individual Gettext Portable Object (<em>.po</em>) file. Normally distributed as part of a translation package (each translation package may contain several <em>.po</em> files), a <em>.po</em> file may need to be imported after off-line editing in a Gettext translation editor. Importing an individual <em>.po</em> file may be a lengthy process.') .'</p>';
  53        $output .= '<p>'. t('Note that the <em>.po</em> files within a translation package are imported automatically (if available) when new modules or themes are enabled, or as new languages are added. Since this page only allows the import of one <em>.po</em> file at a time, it may be simpler to download and extract a translation package into your Drupal installation directory and <a href="@language-add">add the language</a> (which automatically imports all <em>.po</em> files within the package). Translation packages are available for download on the <a href="@translations">Drupal translation page</a>.', array('@language-add' => url('admin/settings/language/add'), '@translations' => 'http://localize.drupal.org')) .'</p>';
  54        return $output;
  55      case 'admin/build/translate/export':
  56        return '<p>'. t('This page exports the translated strings used by your site. An export file may be in Gettext Portable Object (<em>.po</em>) form, which includes both the original string and the translation (used to share translations with others), or in Gettext Portable Object Template (<em>.pot</em>) form, which includes the original strings only (used to create new translations with a Gettext translation editor).') .'</p>';
  57      case 'admin/build/translate/search':
  58        return '<p>'. t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: For translation tasks involving many strings, it may be more convenient to <a href="@export">export</a> strings for off-line editing in a desktop Gettext translation editor.) Searches may be limited to strings found within a specific text group or in a specific language.', array('@export' => url('admin/build/translate/export'))) .'</p>';
  59      case 'admin/build/block/configure':
  60        if ($arg[4] == 'locale' && $arg[5] == 0) {
  61          return '<p>'. t('This block is only shown if <a href="@languages">at least two languages are enabled</a> and <a href="@configuration">language negotiation</a> is set to something other than <em>None</em>.', array('@languages' => url('admin/settings/language'), '@configuration' => url('admin/settings/language/configure'))) .'</p>';
  62        }
  63        break;
  64    }
  65  }
  66  
  67  /**
  68   * Implementation of hook_menu().
  69   *
  70   * Locale module only provides administrative menu items, so all
  71   * menu items are invoked through locale_inc_callback().
  72   */
  73  function locale_menu() {
  74    // Manage languages
  75    $items['admin/settings/language'] = array(
  76      'title' => 'Languages',
  77      'description' => 'Configure languages for content and the user interface.',
  78      'page callback' => 'locale_inc_callback',
  79      'page arguments' => array('drupal_get_form', 'locale_languages_overview_form'),
  80      'access arguments' => array('administer languages'),
  81    );
  82    $items['admin/settings/language/overview'] = array(
  83      'title' => 'List',
  84      'weight' => 0,
  85      'type' => MENU_DEFAULT_LOCAL_TASK,
  86    );
  87    $items['admin/settings/language/add'] = array(
  88      'title' => 'Add language',
  89      'page callback' => 'locale_inc_callback',
  90      'page arguments' => array('locale_languages_add_screen'), // two forms concatenated
  91      'access arguments' => array('administer languages'),
  92      'weight' => 5,
  93      'type' => MENU_LOCAL_TASK,
  94    );
  95    $items['admin/settings/language/configure'] = array(
  96      'title' => 'Configure',
  97      'page callback' => 'locale_inc_callback',
  98      'page arguments' => array('drupal_get_form', 'locale_languages_configure_form'),
  99      'access arguments' => array('administer languages'),
 100      'weight' => 10,
 101      'type' => MENU_LOCAL_TASK,
 102    );
 103    $items['admin/settings/language/edit/%'] = array(
 104      'title' => 'Edit language',
 105      'page callback' => 'locale_inc_callback',
 106      'page arguments' => array('drupal_get_form', 'locale_languages_edit_form', 4),
 107      'access arguments' => array('administer languages'),
 108      'type' => MENU_CALLBACK,
 109    );
 110    $items['admin/settings/language/delete/%'] = array(
 111      'title' => 'Confirm',
 112      'page callback' => 'locale_inc_callback',
 113      'page arguments' => array('drupal_get_form', 'locale_languages_delete_form', 4),
 114      'access arguments' => array('administer languages'),
 115      'type' => MENU_CALLBACK,
 116    );
 117  
 118    // Translation functionality
 119    $items['admin/build/translate'] = array(
 120      'title' => 'Translate interface',
 121      'description' => 'Translate the built in interface and optionally other text.',
 122      'page callback' => 'locale_inc_callback',
 123      'page arguments' => array('locale_translate_overview_screen'), // not a form, just a table
 124      'access arguments' => array('translate interface'),
 125    );
 126    $items['admin/build/translate/overview'] = array(
 127      'title' => 'Overview',
 128      'weight' => 0,
 129      'type' => MENU_DEFAULT_LOCAL_TASK,
 130    );
 131    $items['admin/build/translate/search'] = array(
 132      'title' => 'Search',
 133      'weight' => 10,
 134      'type' => MENU_LOCAL_TASK,
 135      'page callback' => 'locale_inc_callback',
 136      'page arguments' => array('locale_translate_seek_screen'), // search results and form concatenated
 137      'access arguments' => array('translate interface'),
 138    );
 139    $items['admin/build/translate/import'] = array(
 140      'title' => 'Import',
 141      'page callback' => 'locale_inc_callback',
 142      'page arguments' => array('drupal_get_form', 'locale_translate_import_form'),
 143      'access arguments' => array('translate interface'),
 144      'weight' => 20,
 145      'type' => MENU_LOCAL_TASK,
 146    );
 147    $items['admin/build/translate/export'] = array(
 148      'title' => 'Export',
 149      'page callback' => 'locale_inc_callback',
 150      'page arguments' => array('locale_translate_export_screen'), // possibly multiple forms concatenated
 151      'access arguments' => array('translate interface'),
 152      'weight' => 30,
 153      'type' => MENU_LOCAL_TASK,
 154    );
 155    $items['admin/build/translate/edit/%'] = array(
 156      'title' => 'Edit string',
 157      'page callback' => 'locale_inc_callback',
 158      'page arguments' => array('drupal_get_form', 'locale_translate_edit_form', 4),
 159      'access arguments' => array('translate interface'),
 160      'type' => MENU_CALLBACK,
 161    );
 162    $items['admin/build/translate/delete/%'] = array(
 163      'title' => 'Delete string',
 164      'page callback' => 'locale_inc_callback',
 165      'page arguments' => array('locale_translate_delete_page', 4),
 166      'access arguments' => array('translate interface'),
 167      'type' => MENU_CALLBACK,
 168    );
 169  
 170    return $items;
 171  }
 172  
 173  /**
 174   * Wrapper function to be able to set callbacks in locale.inc
 175   */
 176  function locale_inc_callback() {
 177    $args = func_get_args();
 178    $function = array_shift($args);
 179    include_once  './includes/locale.inc';
 180    return call_user_func_array($function, $args);
 181  }
 182  
 183  /**
 184   * Implementation of hook_perm().
 185   */
 186  function locale_perm() {
 187    return array('administer languages', 'translate interface');
 188  }
 189  
 190  /**
 191   * Implementation of hook_locale().
 192   */
 193  function locale_locale($op = 'groups') {
 194    switch ($op) {
 195      case 'groups':
 196        return array('default' => t('Built-in interface'));
 197    }
 198  }
 199  
 200  /**
 201   * Implementation of hook_user().
 202   */
 203  function locale_user($type, $edit, &$user, $category = NULL) {
 204    global $language;
 205  
 206    // If we have more then one language and either creating a user on the
 207    // admin interface or edit the user, show the language selector.
 208    if (variable_get('language_count', 1) > 1 && ($type == 'register' && user_access('administer users') || $type == 'form' && $category == 'account' )) {
 209      $languages = language_list('enabled');
 210      $languages = $languages[1];
 211  
 212      // If the user is being created, we set the user language to the page language.
 213      $user_preferred_language = $user ? user_preferred_language($user) : $language;
 214  
 215      $names = array();
 216      foreach ($languages as $langcode => $item) {
 217        $name = t($item->name);
 218        $names[check_plain($langcode)] = check_plain($name . ($item->native != $name ? ' ('. $item->native .')' : ''));
 219      }
 220      $form['locale'] = array(
 221        '#type' => 'fieldset',
 222        '#title' => t('Language settings'),
 223        '#weight' => 1,
 224      );
 225  
 226      // Get language negotiation settings.
 227      $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE);
 228      $form['locale']['language'] = array(
 229        '#type' => (count($names) <= 5 ? 'radios' : 'select'),
 230        '#title' => t('Language'),
 231        '#default_value' => check_plain($user_preferred_language->language),
 232        '#options' => $names,
 233        '#description' => ($mode == LANGUAGE_NEGOTIATION_PATH) ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),
 234      );
 235      return $form;
 236    }
 237  }
 238  
 239  /**
 240   * Implementation of hook_form_alter(). Adds language fields to forms.
 241   */
 242  function locale_form_alter(&$form, $form_state, $form_id) {
 243    switch ($form_id) {
 244  
 245      // Language field for paths
 246      case 'path_admin_form':
 247        $form['language'] = array(
 248          '#type' => 'select',
 249          '#title' => t('Language'),
 250          '#options' => array('' => t('All languages')) + locale_language_list('name'),
 251          '#default_value' => $form['language']['#value'],
 252          '#weight' => -10,
 253          '#description' => t('A path alias set for a specific language will always be used when displaying this page in that language, and takes precedence over path aliases set for <em>All languages</em>.'),
 254        );
 255        break;
 256  
 257      // Language setting for content types
 258      case 'node_type_form':
 259        if (isset($form['identity']['type'])) {
 260          $form['workflow']['language_content_type'] = array(
 261            '#type' => 'radios',
 262            '#title' => t('Multilingual support'),
 263            '#default_value' => variable_get('language_content_type_'. $form['#node_type']->type, 0),
 264            '#options' => array(t('Disabled'), t('Enabled')),
 265            '#description' => t('Enable multilingual support for this content type. If enabled, a language selection field will be added to the editing form, allowing you to select from one of the <a href="!languages">enabled languages</a>. If disabled, new posts are saved with the default language. Existing content will not be affected by changing this option.', array('!languages' => url('admin/settings/language'))),
 266          );
 267        }
 268        break;
 269  
 270      // Language field for nodes
 271      default:
 272        if (isset($form['#id']) && $form['#id'] == 'node-form') {
 273          if (isset($form['#node']->type) && variable_get('language_content_type_'. $form['#node']->type, 0)) {
 274            $form['language'] = array(
 275              '#type' => 'select',
 276              '#title' => t('Language'),
 277              '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
 278              '#options' => array('' => t('Language neutral')) + locale_language_list('name'),
 279            );
 280          }
 281          // Node type without language selector: assign the default for new nodes
 282          elseif (!isset($form['#node']->nid)) {
 283            $default = language_default();
 284            $form['language'] = array(
 285              '#type' => 'value',
 286              '#value' => $default->language
 287            );
 288          }
 289        }
 290    }
 291  }
 292  
 293  /**
 294   * Implementation of hook_theme()
 295   */
 296  function locale_theme() {
 297    return array(
 298      'locale_languages_overview_form' => array(
 299        'arguments' => array('form' => array()),
 300      ),
 301    );
 302  }
 303  
 304  /**
 305   * Implementation of hook_node_type().
 306   */
 307  function locale_node_type($op, $info) {
 308    if ($op == 'delete') {
 309      variable_del('language_content_type_'. $info->type);
 310    }
 311  }
 312  
 313  // ---------------------------------------------------------------------------------
 314  // Locale core functionality
 315  
 316  /**
 317   * Provides interface translation services.
 318   *
 319   * This function is called from t() to translate a string if needed.
 320   *
 321   * @param $string
 322   *   A string to look up translation for. If omitted, all the
 323   *   cached strings will be returned in all languages already
 324   *   used on the page.
 325   * @param $langcode
 326   *   Language code to use for the lookup.
 327   * @param $reset
 328   *   Set to TRUE to reset the in-memory cache.
 329   */
 330  function locale($string = NULL, $langcode = NULL, $reset = FALSE) {
 331    global $language;
 332    static $locale_t;
 333  
 334    if ($reset) {
 335      // Reset in-memory cache.
 336      $locale_t = NULL;
 337    }
 338  
 339    if (!isset($string)) {
 340      // Return all cached strings if no string was specified
 341      return $locale_t;
 342    }
 343  
 344    $langcode = isset($langcode) ? $langcode : $language->language;
 345  
 346    // Store database cached translations in a static var.
 347    if (!isset($locale_t[$langcode])) {
 348      $locale_t[$langcode] = array();
 349      // Disabling the usage of string caching allows a module to watch for
 350      // the exact list of strings used on a page. From a performance
 351      // perspective that is a really bad idea, so we have no user
 352      // interface for this. Be careful when turning this option off!
 353      if (variable_get('locale_cache_strings', 1) == 1) {
 354        if ($cache = cache_get('locale:'. $langcode, 'cache')) {
 355          $locale_t[$langcode] = $cache->data;
 356        }
 357        elseif (lock_acquire('locale_cache_' . $langcode)) {
 358          // Refresh database stored cache of translations for given language.
 359          // We only store short strings used in current version, to improve
 360          // performance and consume less memory.
 361          $result = db_query("SELECT s.source, t.translation, t.language FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = '%s' WHERE s.textgroup = 'default' AND s.version = '%s' AND LENGTH(s.source) < 75", $langcode, VERSION);
 362          while ($data = db_fetch_object($result)) {
 363            $locale_t[$langcode][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
 364          }
 365          cache_set('locale:'. $langcode, $locale_t[$langcode]);
 366          lock_release('locale_cache_' . $langcode);
 367        }
 368      }
 369    }
 370  
 371    // If we have the translation cached, skip checking the database
 372    if (!isset($locale_t[$langcode][$string])) {
 373  
 374      // We do not have this translation cached, so get it from the DB.
 375      $translation = db_fetch_object(db_query("SELECT s.lid, t.translation, s.version FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = '%s' WHERE s.source = '%s' AND s.textgroup = 'default'", $langcode, $string));
 376      if ($translation) {
 377        // We have the source string at least.
 378        // Cache translation string or TRUE if no translation exists.
 379        $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
 380  
 381        if ($translation->version != VERSION) {
 382          // This is the first use of this string under current Drupal version. Save version
 383          // and clear cache, to include the string into caching next time. Saved version is
 384          // also a string-history information for later pruning of the tables.
 385          db_query("UPDATE {locales_source} SET version = '%s' WHERE lid = %d", VERSION, $translation->lid);
 386          cache_clear_all('locale:', 'cache', TRUE);
 387        }
 388      }
 389      else {
 390        // We don't have the source string, cache this as untranslated.
 391        db_query("INSERT INTO {locales_source} (location, source, textgroup, version) VALUES ('%s', '%s', 'default', '%s')", request_uri(), $string, VERSION);
 392        $locale_t[$langcode][$string] = TRUE;
 393        // Clear locale cache so this string can be added in a later request.
 394        cache_clear_all('locale:', 'cache', TRUE);
 395      }
 396    }
 397  
 398    return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
 399  }
 400  
 401  /**
 402   * Returns plural form index for a specific number.
 403   *
 404   * The index is computed from the formula of this language.
 405   *
 406   * @param $count
 407   *   Number to return plural for.
 408   * @param $langcode
 409   *   Optional language code to translate to a language other than
 410   *   what is used to display the page.
 411   */
 412  function locale_get_plural($count, $langcode = NULL) {
 413    global $language;
 414    static $locale_formula, $plurals = array();
 415  
 416    $langcode = $langcode ? $langcode : $language->language;
 417  
 418    if (!isset($plurals[$langcode][$count])) {
 419      if (!isset($locale_formula)) {
 420        $language_list = language_list();
 421        $locale_formula[$langcode] = $language_list[$langcode]->formula;
 422      }
 423      if ($locale_formula[$langcode]) {
 424        $n = $count;
 425        $plurals[$langcode][$count] = @eval('return intval('. $locale_formula[$langcode] .');');
 426        return $plurals[$langcode][$count];
 427      }
 428      else {
 429        $plurals[$langcode][$count] = -1;
 430        return -1;
 431      }
 432    }
 433    return $plurals[$langcode][$count];
 434  }
 435  
 436  
 437  /**
 438   * Returns a language name
 439   */
 440  function locale_language_name($lang) {
 441    static $list = NULL;
 442    if (!isset($list)) {
 443      $list = locale_language_list();
 444    }
 445    return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
 446  }
 447  
 448  /**
 449   * Returns array of language names
 450   *
 451   * @param $field
 452   *   'name' => names in current language, localized
 453   *   'native' => native names
 454   * @param $all
 455   *   Boolean to return all languages or only enabled ones
 456   */
 457  function locale_language_list($field = 'name', $all = FALSE) {
 458    if ($all) {
 459      $languages = language_list();
 460    }
 461    else {
 462      $languages = language_list('enabled');
 463      $languages = $languages[1];
 464    }
 465    $list = array();
 466    foreach ($languages as $language) {
 467      $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
 468    }
 469    return $list;
 470  }
 471  
 472  /**
 473   * Imports translations when new modules or themes are installed or enabled.
 474   *
 475   * This function will either import translation for the component change
 476   * right away, or start a batch if more files need to be imported.
 477   *
 478   * @param $components
 479   *   An array of component (theme and/or module) names to import
 480   *   translations for.
 481   */
 482  function locale_system_update($components) {
 483    include_once  'includes/locale.inc';
 484    if ($batch = locale_batch_by_component($components)) {
 485      batch_set($batch);
 486    }
 487  }
 488  
 489  /**
 490   * Update JavaScript translation file, if required, and add it to the page.
 491   *
 492   * This function checks all JavaScript files currently added via drupal_add_js()
 493   * and invokes parsing if they have not yet been parsed for Drupal.t()
 494   * and Drupal.formatPlural() calls. Also refreshes the JavaScript translation
 495   * file if necessary, and adds it to the page.
 496   */
 497  function locale_update_js_files() {
 498    global $language;
 499  
 500    $dir = file_create_path(variable_get('locale_js_directory', 'languages'));
 501    $parsed = variable_get('javascript_parsed', array());
 502  
 503    // The first three parameters are NULL in order to get an array with all
 504    // scopes. This is necessary to prevent recreation of JS translation files
 505    // when new files are added for example in the footer.
 506    $javascript = drupal_add_js(NULL, NULL, NULL);
 507    $files = $new_files = FALSE;
 508  
 509    foreach ($javascript as $scope) {
 510      foreach ($scope as $type => $data) {
 511        if ($type != 'setting' && $type != 'inline') {
 512          foreach ($data as $filepath => $info) {
 513            $files = TRUE;
 514            if (!in_array($filepath, $parsed)) {
 515              // Don't parse our own translations files.
 516              if (substr($filepath, 0, strlen($dir)) != $dir) {
 517                locale_inc_callback('_locale_parse_js_file', $filepath);
 518                $parsed[] = $filepath;
 519                $new_files = TRUE;
 520              }
 521            }
 522          }
 523        }
 524      }
 525    }
 526  
 527    // If there are any new source files we parsed, invalidate existing
 528    // JavaScript translation files for all languages, adding the refresh
 529    // flags into the existing array.
 530    if ($new_files) {
 531      $parsed += locale_inc_callback('_locale_invalidate_js');
 532    }
 533  
 534    // If necessary, rebuild the translation file for the current language.
 535    if (!empty($parsed['refresh:'. $language->language])) {
 536      // Don't clear the refresh flag on failure, so that another try will
 537      // be performed later.
 538      if (locale_inc_callback('_locale_rebuild_js')) {
 539        unset($parsed['refresh:'. $language->language]);
 540      }
 541      // Store any changes after refresh was attempted.
 542      variable_set('javascript_parsed', $parsed);
 543    }
 544    // If no refresh was attempted, but we have new source files, we need
 545    // to store them too. This occurs if current page is in English.
 546    else if ($new_files) {
 547      variable_set('javascript_parsed', $parsed);
 548    }
 549  
 550    // Add the translation JavaScript file to the page.
 551    if ($files && !empty($language->javascript)) {
 552      drupal_add_js($dir .'/'. $language->language .'_'. $language->javascript .'.js', 'core');
 553    }
 554  }
 555  
 556  // ---------------------------------------------------------------------------------
 557  // Language switcher block
 558  
 559  /**
 560   * Implementation of hook_block().
 561   * Displays a language switcher. Translation links may be provided by other modules.
 562   */
 563  function locale_block($op = 'list', $delta = 0) {
 564    if ($op == 'list') {
 565      $block[0]['info'] = t('Language switcher');
 566      // Not worth caching.
 567      $block[0]['cache'] = BLOCK_NO_CACHE;
 568      return $block;
 569    }
 570  
 571    // Only show if we have at least two languages and language dependent
 572    // web addresses, so we can actually link to other language versions.
 573    elseif ($op == 'view' && variable_get('language_count', 1) > 1 && variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE) != LANGUAGE_NEGOTIATION_NONE) {
 574      $path = drupal_is_front_page() ? '<front>' : $_GET['q'];
 575      $languages = language_list('enabled');
 576      $links = array();
 577      foreach ($languages[1] as $language) {
 578        $links[$language->language] = array(
 579          'href'       => $path,
 580          'title'      => $language->native,
 581          'language'   => $language,
 582          'attributes' => array('class' => 'language-link'),
 583        );
 584      }
 585  
 586      // Allow modules to provide translations for specific links.
 587      // A translation link may need to point to a different path or use
 588      // a translated link text before going through l(), which will just
 589      // handle the path aliases.
 590      drupal_alter('translation_link', $links, $path);
 591  
 592      $block['subject'] = t('Languages');
 593      $block['content'] = theme('links', $links, array());
 594      return $block;
 595    }
 596  }


Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7