You are here

locale.variable.inc in Variable 7

Same filename and directory in other branches
  1. 7.2 includes/locale.variable.inc

Variable API module. Definition for Drupal core variables

File

includes/locale.variable.inc
View source
<?php

/**
 * @file
 * Variable API module. Definition for Drupal core variables
 */

/**
 * Implements hook_variable_info().
 */
function locale_variable_info($options) {

  // This variable will be altered by translation module. See translation.variable.inc
  $variables['language_content_type_[node_type]'] = array(
    'type' => 'multiple',
    'title' => t('Multilingual support'),
    'repeat' => array(
      'type' => 'enable',
      // Set options here so translation module can add some more
      'options' => array(
        t('Disabled'),
        t('Enabled'),
      ),
    ),
    '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/config/regional/language', $options),
    ), $options),
    'group' => 'node_type_settings',
  );
  $variables['language_default'] = array(
    'title' => t('Site default language'),
    'type' => 'select',
    'group' => 'regional_settings',
    'options callback' => 'locale_variable_options_language',
    'format callback' => 'locale_variable_language_default_format',
    'element callback' => 'locale_variable_language_default_element',
    'default callback' => 'locale_variable_language_default',
  );
  return $variables;
}

/**
 * Implements hook_variable_type_info().
 */
function locale_variable_type_info() {

  // Language code
  $type['language'] = array(
    'title' => t('Language'),
    'options callback' => 'locale_variable_options_language',
    'type' => 'select',
  );
  return $type;
}

/**
 * Callback for all languages
 */
function locale_variable_options_language($variable, $options) {
  return locale_language_list('name', TRUE);
}

/**
 * Form element for site default language
 */
function locale_variable_language_default_element($variable, $options) {
  $element = variable_form_element_options($variable, $options);

  //$element['#default_value'] = $element['#default_value']->language;
  $element['#value_callback'] = 'locale_variable_language_element_value';
  $element['#element_validate'][] = 'locale_variable_language_element_validate';
  return $element;
}

/**
 * Get language default.
 */
function locale_variable_language_default($variable, $options) {
  return language_default();
}

/**
 * Format language object variable
 */
function locale_variable_language_default_format($variable, $options = array()) {
  return !empty($variable['value']) ? check_plain($variable['value']->name) : t('None');
}

/**
 * Map form element value to actual value.
 */
function locale_variable_language_element_value($element, $input = FALSE, $form_state = array()) {
  if ($input === FALSE) {
    return $element['#default_value']->language;
  }
  else {
    return $input;
  }
}

/**
 * Replace language code by language object on submission
 */
function locale_variable_language_element_validate($element, &$form_state, $form) {
  $languages = language_list();
  $form_state['values'][$element['#name']] = $languages[$form_state['values'][$element['#name']]];
}

Functions

Namesort descending Description
locale_variable_info Implements hook_variable_info().
locale_variable_language_default Get language default.
locale_variable_language_default_element Form element for site default language
locale_variable_language_default_format Format language object variable
locale_variable_language_element_validate Replace language code by language object on submission
locale_variable_language_element_value Map form element value to actual value.
locale_variable_options_language Callback for all languages
locale_variable_type_info Implements hook_variable_type_info().