summaryrefslogtreecommitdiffstatshomepage
path: root/core/includes/language.inc
diff options
context:
space:
mode:
Diffstat (limited to 'core/includes/language.inc')
-rw-r--r--core/includes/language.inc551
1 files changed, 0 insertions, 551 deletions
diff --git a/core/includes/language.inc b/core/includes/language.inc
deleted file mode 100644
index 618e3a700280..000000000000
--- a/core/includes/language.inc
+++ /dev/null
@@ -1,551 +0,0 @@
-<?php
-
-/**
- * @file
- * Language Negotiation API.
- *
- * @see http://drupal.org/node/1497272
- */
-
-use Drupal\Core\Language\Language;
-
-/**
- * No language negotiation. The default language is used.
- */
-const LANGUAGE_NEGOTIATION_SELECTED = 'language-selected';
-
-/**
- * The language is determined using the current interface language.
- */
-const LANGUAGE_NEGOTIATION_INTERFACE = 'language-interface';
-
-/**
- * @defgroup language_negotiation Language Negotiation API functionality
- * @{
- * Functions to customize the language types and the negotiation process.
- *
- * The language negotiation API is based on two major concepts:
- * - Language types: types of translatable data (the types of data that a user
- * can view or request).
- * - Language negotiation methods: functions for determining which language to
- * use to present a particular piece of data to the user.
- * Both language types and language negotiation methods are customizable.
- *
- * Drupal defines three built-in language types:
- * - Interface language: The page's main language, used to present translated
- * user interface elements such as titles, labels, help text, and messages.
- * - Content language: The language used to present content that is available
- * in more than one language (see
- * @link field_language Field Language API @endlink for details).
- * - URL language: The language associated with URLs. When generating a URL,
- * this value will be used by url() as a default if no explicit preference is
- * provided.
- * Modules can define additional language types through
- * hook_language_types_info(), and alter existing language type definitions
- * through hook_language_types_info_alter().
- *
- * Language types may be configurable or fixed. The language negotiation
- * methods associated with a configurable language type can be explicitly
- * set through the user interface. A fixed language type has predetermined
- * (module-defined) language negotiation settings and, thus, does not appear in
- * the configuration page. Here is a code snippet that makes the content
- * language (which by default inherits the interface language's values)
- * configurable:
- * @code
- * function mymodule_language_types_info_alter(&$language_types) {
- * unset($language_types[Language::TYPE_CONTENT]['fixed']);
- * }
- * @endcode
- *
- * The locked configuration property prevents one language type from being
- * switched from customized to not customized, and vice versa.
- * @see language_types_set()
- *
- * Every language type can have a different set of language negotiation methods
- * assigned to it. Different language types often share the same language
- * negotiation settings, but they can have independent settings if needed. If
- * two language types are configured the same way, their language switcher
- * configuration will be functionally identical and the same settings will act
- * on both language types.
- *
- * Drupal defines the following built-in language negotiation methods:
- * - URL: Determine the language from the URL (path prefix or domain).
- * - Session: Determine the language from a request/session parameter.
- * - User: Follow the user's language preference.
- * - Browser: Determine the language from the browser's language settings.
- * - Default language: Use the default site language.
- * Language negotiation methods are simple callback functions that implement a
- * particular logic to return a language code. For instance, the URL method
- * searches for a valid path prefix or domain name in the current request URL.
- * If a language negotiation method does not return a valid language code, the
- * next method associated to the language type (based on method weight) is
- * invoked.
- *
- * Modules can define additional language negotiation methods through
- * hook_language_negotiation_info(), and alter existing methods through
- * hook_language_negotiation_info_alter(). Here is an example snippet that lets
- * path prefixes be ignored for administrative paths:
- * @code
- * function mymodule_language_negotiation_info_alter(&$negotiation_info) {
- * // Replace the core function with our own function.
- * module_load_include('language', 'inc', 'language.negotiation');
- * $negotiation_info[LANGUAGE_NEGOTIATION_URL]['callbacks']['negotiation'] = 'mymodule_from_url';
- * $negotiation_info[LANGUAGE_NEGOTIATION_URL]['file'] = drupal_get_path('module', 'mymodule') . '/mymodule.module';
- * }
- *
- * function mymodule_from_url($languages) {
- * // Use the core URL language negotiation method to get a valid language
- * // code.
- * module_load_include('language', 'inc', 'language.negotiation');
- * $langcode = language_from_url($languages);
- *
- * // If we are on an administrative path, override with the default language.
- * $query = \Drupal::request()->query;
- * if ($query->has('q') && strtok($query->get('q'), '/') == 'admin') {
- * return language_default()->id;
- * }
- * return $langcode;
- * }
- * ?>
- * @endcode
- *
- * For more information, see
- * @link http://drupal.org/node/1497272 Language Negotiation API @endlink
- */
-
-/**
- * Chooses a language based on language negotiation method settings.
- *
- * @param $type
- * The language type key to find the language for.
- *
- * @param $request
- * The HttpReqeust object representing the current request.
- *
- * @return
- * The negotiated language object.
- */
-function language_types_initialize($type, $request = NULL) {
- // Execute the language negotiation methods in the order they were set up and
- // return the first valid language found.
- $negotiation = variable_get("language_negotiation_$type", array());
-
- foreach ($negotiation as $method_id => $method) {
- // Skip negotiation methods not appropriate for this type.
- if (isset($method['types']) && !in_array($type, $method['types'])) {
- continue;
- }
- $language = language_negotiation_method_invoke($method_id, $method, $request);
- if ($language) {
- // Remember the method ID used to detect the language.
- $language->method_id = $method_id;
- return $language;
- }
- }
-
- // If no other language was found use the default one.
- $language = language_default();
- $language->method_id = LANGUAGE_NEGOTIATION_SELECTED;
- return $language;
-}
-
-/**
- * Returns information about all defined language types.
- *
- * @return
- * An associative array of language type information arrays keyed by type
- * names. Based on information from hook_language_types_info().
- *
- * @see hook_language_types_info().
- */
-function language_types_info() {
- $language_types = &drupal_static(__FUNCTION__);
-
- if (!isset($language_types)) {
- $language_types = \Drupal::moduleHandler()->invokeAll('language_types_info');
- // Let other modules alter the list of language types.
- drupal_alter('language_types_info', $language_types);
- }
-
- return $language_types;
-}
-
-/**
- * Returns only the configurable language types.
- *
- * A language type maybe configurable or fixed. A fixed language type is a type
- * whose language negotiation methods are module-defined and not altered through
- * the user interface.
- *
- * @return
- * An array of language type names.
- */
-function language_types_get_configurable() {
- $configurable = \Drupal::config('system.language.types')->get('configurable');
- return $configurable ? $configurable : array();
-}
-
-/**
- * Disables the given language types.
- *
- * @param $types
- * An array of language types.
- */
-function language_types_disable($types) {
- $configurable = language_types_get_configurable();
- \Drupal::config('system.language.types')->set('configurable', array_diff($configurable, $types))->save();
-}
-
-/**
- * Updates the language type configuration.
- *
- * @param array $configurable_language_types
- * An array of configurable language types.
- */
-function language_types_set(array $configurable_language_types) {
- // Ensure that we are getting the defined language negotiation information. An
- // invocation of \Drupal\Core\Extension\ModuleHandler::install() or
- // \Drupal\Core\Extension\ModuleHandler::uninstall() could invalidate the
- // cached information.
- drupal_static_reset('language_types_info');
- drupal_static_reset('language_negotiation_info');
-
- $language_types = array();
- $negotiation_info = language_negotiation_info();
- $language_types_info = language_types_info();
-
- foreach ($language_types_info as $type => $info) {
- $configurable = in_array($type, $configurable_language_types);
-
- // Check whether the language type is unlocked. Only the status of unlocked
- // language types can be toggled between configurable and non-configurable.
- // The default language negotiation settings, if available, are stored in
- // $info['fixed'].
- if (empty($info['locked'])) {
- // If we have a non-locked non-configurable language type without default
- // language negotiation settings, we use the values negotiated for the
- // interface language which should always be available.
- if (!$configurable && !empty($info['fixed'])) {
- $method_weights = array(LANGUAGE_NEGOTIATION_INTERFACE);
- $method_weights = array_flip($method_weights);
- language_negotiation_set($type, $method_weights);
- }
- }
- else {
- // Locked language types with default settings are always considered
- // non-configurable. In turn if default settings are missing, the language
- // type is always considered configurable.
- $configurable = empty($info['fixed']);
-
- // If the language is non-configurable we need to store its language
- // negotiation settings.
- if (!$configurable) {
- $method_weights = array();
- foreach ($info['fixed'] as $weight => $method_id) {
- if (isset($negotiation_info[$method_id])) {
- $method_weights[$method_id] = $weight;
- }
- }
- language_negotiation_set($type, $method_weights);
- }
- }
-
- $language_types[$type] = $configurable;
- }
-
- // Store the language type configuration.
- $config = \Drupal::config('system.language.types');
- $config->set('configurable', array_keys(array_filter($language_types)))->save();
- $config->set('all', array_keys($language_types))->save();
-
- // Ensure that subsequent calls of language_types_get_configurable() return
- // the updated language type information.
- drupal_static_reset('language_types_get_configurable');
-}
-
-/**
- * Returns the ID of the language type's first language negotiation method.
- *
- * @param $type
- * The language type.
- *
- * @return
- * The identifier of the first language negotiation method for the given
- * language type, or the default method if none exists.
- */
-function language_negotiation_method_get_first($type) {
- $negotiation = variable_get("language_negotiation_$type", array());
- return empty($negotiation) ? LANGUAGE_NEGOTIATION_SELECTED : key($negotiation);
-}
-
-/**
- * Checks whether a language negotiation method is enabled for a language type.
- *
- * @param $method_id
- * The language negotiation method ID.
- * @param $type
- * (optional) The language type. If none is passed, all the configurable
- * language types will be inspected.
- *
- * @return
- * TRUE if the method is enabled for at least one of the given language
- * types, or FALSE otherwise.
- */
-function language_negotiation_method_enabled($method_id, $type = NULL) {
- $language_types = !empty($type) ? array($type) : language_types_get_configurable();
-
- foreach ($language_types as $type) {
- $negotiation = variable_get("language_negotiation_$type", array());
- if (isset($negotiation[$method_id])) {
- return TRUE;
- }
- }
-
- return FALSE;
-}
-
-/**
- * Returns the language switch links for the given language type.
- *
- * @param $type
- * The language type.
- * @param $path
- * The internal path the switch links will be relative to.
- *
- * @return
- * A keyed array of links ready to be themed.
- */
-function language_negotiation_get_switch_links($type, $path) {
- $links = FALSE;
- $negotiation = variable_get("language_negotiation_$type", array());
-
- foreach ($negotiation as $method_id => $method) {
- if (isset($method['callbacks']['language_switch'])) {
- if (isset($method['file'])) {
- require_once DRUPAL_ROOT . '/' . $method['file'];
- }
-
- $callback = $method['callbacks']['language_switch'];
- $result = $callback($type, $path);
-
- if (!empty($result)) {
- // Allow modules to provide translations for specific links.
- drupal_alter('language_switch_links', $result, $type, $path);
- $links = (object) array('links' => $result, 'method_id' => $method_id);
- break;
- }
- }
- }
-
- return $links;
-}
-
-/**
- * Removes any language negotiation methods that are no longer defined.
- */
-function language_negotiation_purge() {
- // Ensure that we are getting the defined language negotiation information. An
- // invocation of \Drupal\Core\Extension\ModuleHandler::install() or
- // \Drupal\Core\Extension\ModuleHandler::uninstall() could invalidate the
- // cached information.
- drupal_static_reset('language_negotiation_info');
- drupal_static_reset('language_types_info');
-
- $negotiation_info = language_negotiation_info();
- foreach (language_types_info() as $type => $type_info) {
- $weight = 0;
- $method_weights = array();
- foreach (variable_get("language_negotiation_$type", array()) as $method_id => $method) {
- if (isset($negotiation_info[$method_id])) {
- $method_weights[$method_id] = $weight++;
- }
- }
- language_negotiation_set($type, $method_weights);
- }
-}
-
-/**
- * Saves a list of language negotiation methods for a language type.
- *
- * @param $type
- * The language type.
- * @param $method_weights
- * An array of language negotiation method weights keyed by method ID.
- */
-function language_negotiation_set($type, $method_weights) {
- // Save only the necessary fields.
- $method_fields = array('callbacks', 'file', 'cache');
-
- $negotiation = array();
- $negotiation_info = language_negotiation_info();
- $default_types = language_types_get_configurable();
-
- // Order the language negotiation method list by weight.
- asort($method_weights);
-
- foreach ($method_weights as $method_id => $weight) {
- if (isset($negotiation_info[$method_id])) {
- $method = $negotiation_info[$method_id];
- // If the language negotiation method does not express any preference
- // about types, make it available for any configurable type.
- $types = array_flip(isset($method['types']) ? $method['types'] : $default_types);
- // Check whether the method is defined and has the right type.
- if (isset($types[$type])) {
- $method_data = array();
- foreach ($method_fields as $field) {
- if (isset($method[$field])) {
- $method_data[$field] = $method[$field];
- }
- }
- $negotiation[$method_id] = $method_data;
- }
- }
- }
-
- variable_set("language_negotiation_$type", $negotiation);
-}
-
-/**
- * Returns all defined language negotiation methods.
- *
- * @return
- * An array of language negotiation methods.
- */
-function language_negotiation_info() {
- $negotiation_info = &drupal_static(__FUNCTION__);
-
- if (!isset($negotiation_info)) {
- // Collect all the module-defined language negotiation methods.
- $negotiation_info = \Drupal::moduleHandler()->invokeAll('language_negotiation_info');
- $languages = language_list();
- $selected_language = $languages[language_from_selected($languages)];
- $description = 'Language based on a selected language. ';
- $description .= ($selected_language->id == language_default()->id) ? "(Site's default language (@language_name))" : '(@language_name)';
- // Add the default language negotiation method.
- $negotiation_info[LANGUAGE_NEGOTIATION_SELECTED] = array(
- 'callbacks' => array(
- 'negotiation' => 'language_from_selected',
- ),
- 'weight' => 12,
- 'name' => t('Selected language'),
- 'description' => t($description, array('@language_name' => $selected_language->name)),
- 'config' => 'admin/config/regional/language/detection/selected',
- );
-
- // Let other modules alter the list of language negotiation methods.
- drupal_alter('language_negotiation_info', $negotiation_info);
- }
-
- return $negotiation_info;
-}
-
-/**
- * Invokes a language negotiation method and caches the results.
- *
- * @param $method_id
- * The language negotiation method's identifier.
- * @param $method
- * (optional) An associative array of information about the method to be
- * invoked (see hook_language_negotiation_info() for details). If not passed
- * in, it will be loaded through language_negotiation_info().
- *
- * @param $request
- * (optional) The HttpRequest object representing the current request.
- *
- * @return
- * A language object representing the language chosen by the method.
- */
-function language_negotiation_method_invoke($method_id, $method = NULL, $request = NULL) {
- $results = &drupal_static(__FUNCTION__);
-
- if (!isset($results[$method_id])) {
- global $user;
-
- $languages = language_list();
-
- if (!isset($method)) {
- $negotiation_info = language_negotiation_info();
- $method = $negotiation_info[$method_id];
- }
-
- if (isset($method['file'])) {
- require_once DRUPAL_ROOT . '/' . $method['file'];
- }
- // Check for a cache mode force from settings.php.
- if (settings()->get('page_cache_without_database')) {
- $cache_enabled = TRUE;
- }
- else {
- drupal_bootstrap(DRUPAL_BOOTSTRAP_VARIABLES, FALSE);
- $config = \Drupal::config('system.performance');
- $cache_enabled = $config->get('cache.page.use_internal');
- }
- // If the language negotiation method has no cache preference or this is
- // satisfied we can execute the callback.
- $cache = !isset($method['cache']) || $user->isAuthenticated() || $method['cache'] == $cache_enabled;
- $callback = isset($method['callbacks']['negotiation']) ? $method['callbacks']['negotiation'] : FALSE;
- $langcode = $cache && function_exists($callback) ? $callback($languages, $request) : FALSE;
- $results[$method_id] = isset($languages[$langcode]) ? $languages[$langcode] : FALSE;
- }
-
- // Since objects are resources, we need to return a clone to prevent the
- // language negotiation method cache from being unintentionally altered. The
- // same methods might be used with different language types based on
- // configuration.
- return !empty($results[$method_id]) ? clone($results[$method_id]) : $results[$method_id];
-}
-
- /**
- * Identifies language from configuration.
- *
- * @param $languages
- * An array of valid language objects.
- *
- * @return
- * A valid language code on success, FALSE otherwise.
- */
-function language_from_selected($languages) {
- $langcode = (string) \Drupal::config('language.negotiation')->get('selected_langcode');
- // Replace the site's default langcode by its real value.
- if ($langcode == 'site_default') {
- $langcode = language_default()->id;
- }
- return isset($languages[$langcode]) ? $langcode : language_default()->id;
-}
-
-/**
- * Splits the given path into prefix and actual path.
- *
- * Parse the given path and return the language object identified by the prefix
- * and the actual path.
- *
- * @param $path
- * The path to split.
- * @param $languages
- * An array of valid languages.
- *
- * @return
- * An array composed of:
- * - A language object corresponding to the identified prefix on success,
- * FALSE otherwise.
- * - The path without the prefix on success, the given path otherwise.
- */
-function language_url_split_prefix($path, $languages) {
- $args = empty($path) ? array() : explode('/', $path);
- $prefix = array_shift($args);
-
- // Search prefix within enabled languages.
- $prefixes = language_negotiation_url_prefixes();
- foreach ($languages as $language) {
- if (isset($prefixes[$language->id]) && $prefixes[$language->id] == $prefix) {
- // Rebuild $path with the language removed.
- return array($language, implode('/', $args));
- }
- }
-
- return array(FALSE, $path);
-}
-
-/**
- * @} End of "language_negotiation"
- */