summaryrefslogtreecommitdiff
path: root/modules/locale
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2012-03-08 11:31:47 -0800
committerJennifer Hodgdon <yahgrp@poplarware.com>2012-03-08 11:31:47 -0800
commitb903eea5350f2e81d85dde361fe6ae88cc51bd1c (patch)
tree3b2bed6a7c8372059ba1ba6ae4824e55d26ec2ee /modules/locale
parent465cab13f138f37a2158fbea04f5e1007a097bb9 (diff)
downloadbrdo-b903eea5350f2e81d85dde361fe6ae88cc51bd1c.tar.gz
brdo-b903eea5350f2e81d85dde361fe6ae88cc51bd1c.tar.bz2
Issue #1470080 by Gábor Hojtsy: Move docs for hooks that are not locale.module specific to a modules/system file
Diffstat (limited to 'modules/locale')
-rw-r--r--modules/locale/locale.api.php155
1 files changed, 0 insertions, 155 deletions
diff --git a/modules/locale/locale.api.php b/modules/locale/locale.api.php
index 2808f338c..1f11fc903 100644
--- a/modules/locale/locale.api.php
+++ b/modules/locale/locale.api.php
@@ -24,150 +24,6 @@ function hook_locale($op = 'groups') {
}
/**
- * Allows modules to act after language initialization has been performed.
- *
- * This is primarily needed to provide translation for configuration variables
- * in the proper bootstrap phase. Variables are user-defined strings and
- * therefore should not be translated via t(), since the source string can
- * change without notice and any previous translation would be lost. Moreover,
- * since variables can be used in the bootstrap phase, we need a bootstrap hook
- * to provide a translation early enough to avoid misalignments between code
- * using the original values and code using the translated values. However
- * modules implementing hook_boot() should be aware that language initialization
- * did not happen yet and thus they cannot rely on translated variables.
- */
-function hook_language_init() {
- global $language, $conf;
-
- switch ($language->language) {
- case 'it':
- $conf['site_name'] = 'Il mio sito Drupal';
- break;
-
- case 'fr':
- $conf['site_name'] = 'Mon site Drupal';
- break;
- }
-}
-
-/**
- * Perform alterations on language switcher links.
- *
- * A language switcher link may need to point to a different path or use a
- * translated link text before going through l(), which will just handle the
- * path aliases.
- *
- * @param $links
- * Nested array of links keyed by language code.
- * @param $type
- * The language type the links will switch.
- * @param $path
- * The current path.
- */
-function hook_language_switch_links_alter(array &$links, $type, $path) {
- global $language;
-
- if ($type == LANGUAGE_TYPE_CONTENT && isset($links[$language->language])) {
- foreach ($links[$language->language] as $link) {
- $link['attributes']['class'][] = 'active-language';
- }
- }
-}
-
-/**
- * Allow modules to define their own language types.
- *
- * @return
- * An array of language type definitions. Each language type has an identifier
- * key. The language type definition is an associative array that may contain
- * the following key-value pairs:
- * - "name": The human-readable language type identifier.
- * - "description": A description of the language type.
- * - "fixed": An array of language provider identifiers. Defining this key
- * makes the language type non-configurable.
- */
-function hook_language_types_info() {
- return array(
- 'custom_language_type' => array(
- 'name' => t('Custom language'),
- 'description' => t('A custom language type.'),
- ),
- 'fixed_custom_language_type' => array(
- 'fixed' => array('custom_language_provider'),
- ),
- );
-}
-
-/**
- * Perform alterations on language types.
- *
- * @param $language_types
- * Array of language type definitions.
- */
-function hook_language_types_info_alter(array &$language_types) {
- if (isset($language_types['custom_language_type'])) {
- $language_types['custom_language_type_custom']['description'] = t('A far better description.');
- }
-}
-
-/**
- * Allow modules to define their own language providers.
- *
- * @return
- * An array of language provider definitions. Each language provider has an
- * identifier key. The language provider definition is an associative array
- * that may contain the following key-value pairs:
- * - "types": An array of allowed language types. If a language provider does
- * not specify which language types it should be used with, it will be
- * available for all the configurable language types.
- * - "callbacks": An array of functions that will be called to perform various
- * tasks. Possible key-value pairs are:
- * - "language": Required. The callback that will determine the language
- * value.
- * - "switcher": The callback that will determine the language switch links
- * associated to the current language provider.
- * - "url_rewrite": The callback that will provide URL rewriting.
- * - "file": A file that will be included before the callback is invoked; this
- * allows callback functions to be in separate files.
- * - "weight": The default weight the language provider has.
- * - "name": A human-readable identifier.
- * - "description": A description of the language provider.
- * - "config": An internal path pointing to the language provider
- * configuration page.
- * - "cache": The value Drupal's page cache should be set to for the current
- * language provider to be invoked.
- */
-function hook_language_negotiation_info() {
- return array(
- 'custom_language_provider' => array(
- 'callbacks' => array(
- 'language' => 'custom_language_provider_callback',
- 'switcher' => 'custom_language_switcher_callback',
- 'url_rewrite' => 'custom_language_url_rewrite_callback',
- ),
- 'file' => drupal_get_path('module', 'custom') . '/custom.module',
- 'weight' => -4,
- 'types' => array('custom_language_type'),
- 'name' => t('Custom language provider'),
- 'description' => t('This is a custom language provider.'),
- 'cache' => 0,
- ),
- );
-}
-
-/**
- * Perform alterations on language providers.
- *
- * @param $language_providers
- * Array of language provider definitions.
- */
-function hook_language_negotiation_info_alter(array &$language_providers) {
- if (isset($language_providers['custom_language_provider'])) {
- $language_providers['custom_language_provider']['config'] = 'admin/config/regional/language/configure/custom-language-provider';
- }
-}
-
-/**
* Allow modules to react to language settings changes.
*
* Every module needing to act when the number of enabled languages changes
@@ -181,16 +37,5 @@ function hook_multilingual_settings_changed() {
}
/**
- * Perform alterations on the language fallback candidates.
- *
- * @param $fallback_candidates
- * An array of language codes whose order will determine the language fallback
- * order.
- */
-function hook_language_fallback_candidates_alter(array &$fallback_candidates) {
- $fallback_candidates = array_reverse($fallback_candidates);
-}
-
-/**
* @} End of "addtogroup hooks".
*/