languageicons.module in Language Icons 7

Icons for language links.

This is a spin off from the Internationalization (i18n) package.

File

languageicons.module

<?php

/**
 * @file
 * Icons for language links.
 *
 * This is a spin off from the Internationalization (i18n) package.
 */

/**
 * Implements hook_theme().
 */
function languageicons_theme() {
  return array(
    'languageicons_icon' => array(
      'variables' => array(
        'language' => NULL,
        'title' => NULL,
      ),
    ),
    'languageicons_place' => array(
      'variables' => array(
        'text' => NULL,
        'icon' => NULL,
        'separator' => ' ',
      ),
    ),
  );
}

/**
 * Implements hook_help().
 *
 * @todo The @handbook link needs to change to a module specific one.
 */
function languageicons_help($path, $arg) {
  switch ($path) {
    case 'admin/help#languageicons':
      $output = '<p>' . t('This module manages language icons for multilingual sites:') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Automatically adds icons to language links.') . '</li>';
      $output .= '<li>' . t('Provides related theme functions.') . '</li>';
      $output .= '</ul>';
      $output .= '<p>' . t('For more information, please see <a href="@handbook">the online handbook section</a>.', array(
        '@handbook' => 'http://drupal.org/node/133977',
      )) . '</p>';
      return $output;
    case 'admin/config/regional/language/icons':
      $output = '<p>' . t('To enable multilingual support for specific content types go to <a href="@configure_content_types">configure content types</a>.', array(
        '@configure_content_types' => url('admin/structure/types'),
      )) . '</p>';
      return $output;
  }
}

/**
 * Implements hook_menu().
 */
function languageicons_menu() {
  $items['admin/config/regional/language/icons'] = array(
    'title' => 'Language icons',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'languageicons_admin_settings',
    ),
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
    'access arguments' => array(
      'administer languages',
    ),
    'file' => 'languageicons.admin.inc',
  );
  return $items;
}

/**
 * Implements hook_language_switch_links_alter().
 *
 * Adds language icons to language switcher block links.
 *
 * @todo Figure out a way to either ignore node links or specifically target
 *   them here. See http://drupal.org/node/1005144 for more info.
 */
function languageicons_language_switch_links_alter(array &$links, $type, $path) {
  if (variable_get('languageicons_show_block', 1) || variable_get('languageicons_show_node', 1)) {
    foreach (array_keys($links) as $langcode) {
      if (!isset($links[$langcode]['language'])) {
        $lang_obj['language'] = $langcode;
        $links[$langcode]['language'] = (object) $lang_obj;
      }
      languageicons_link_add($links[$langcode]);
    }
  }
}

/**
 * Add language icon to link.
 *
 * The language icon may be a different language as the destination page, can be passed in 'language_icon'.
 */
function languageicons_link_add(&$link, $title = NULL) {
  $language = isset($link['language_icon']) ? $link['language_icon'] : $link['language'];
  $title = $title ? $title : $link['title'];
  $icon = theme('languageicons_icon', array(
    'language' => $language,
    'title' => check_plain($title),
  ));
  if ($icon) {
    $link['title'] = theme('languageicons_place', array(
      'text' => check_plain($link['title']),
      'icon' => $icon,
    ));
    $link['html'] = TRUE;
  }
}

/**
 * Theme language icon.
 *
 * This function can be overridden for no language icons.
 *
 * @seealso theme_image()
 */
function theme_languageicons_icon($variables) {
  $language = $variables['language'];
  $title = $variables['title'];
  if ($path = variable_get('languageicons_path', drupal_get_path('module', 'languageicons') . '/flags/*.png')) {
    $title = $title ? $title : $language->native;

    // Build up $image for theme_image() consumption.
    $image = array(
      'path' => str_replace('*', $language->language, check_plain($path)),
      'alt' => $title,
      'title' => $title,
      'attributes' => array(
        'class' => array(
          'language-icon',
        ),
      ),
    );
    if ($size = check_plain(variable_get('languageicons_size', '16x12'))) {
      list($width, $height) = explode('x', $size);
      $image += array(
        'width' => $width,
        'height' => $height,
      );
    }
    return theme('image', $image);
  }
}

/**
 * Theme language icon and text.
 *
 * @ingroup themeable
 */
function theme_languageicons_place($variables) {
  $text = $variables['text'];
  $icon = $variables['icon'];
  $separator = $variables['separator'];
  switch (variable_get('languageicons_placement', 'before')) {
    case 'after':
      return $text . $separator . $icon;
    case 'replace':
      return $icon;
    case 'before':
    default:
      return $icon . $separator . $text;
  }
}

Functions

Name	Description
languageicons_help	Implements hook_help().
languageicons_language_switch_links_alter	Implements hook_language_switch_links_alter().
languageicons_link_add	Add language icon to link.
languageicons_menu	Implements hook_menu().
languageicons_theme	Implements hook_theme().
theme_languageicons_icon	Theme language icon.
theme_languageicons_place	Theme language icon and text.