coder_review_i18n.inc in Coder 7

This include file implements coder functionality to check for Internationalization issues.

File

coder_review/includes/coder_review_i18n.inc

<?php

/**
 * @file
 * This include file implements coder functionality to check for Internationalization issues.
 */

/**
 * Implements hook_reviews().
 */
function coder_review_i18n_reviews() {
  $argex = '(((\\$?)[a-zA-Z_]+((\\([^)]*\\))|\\[[^\\]]*\\])?)|[0-9]+(\\.[0-9]*)?|\'\'|"")';
  $rules = array(
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]l\\s*\\(\\s*["\']',
      '#filename-not' => array(
        'install',
      ),
      '#warning_callback' => '_coder_review_i18n_l_without_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]l\\s*\\(\\s*[\'"]',
      '#function' => '_install$',
      '#warning_callback' => '_coder_review_i18n_in_install_l_without_st',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]t\\s*\\(\\s*[\'"]',
      '#function' => '_install$',
      '#warning_callback' => '_coder_review_i18n_in_install_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]alert\\s*\\(\\s*[\'"]',
      '#filename' => array(
        'js',
      ),
      '#warning' => 'Javascript strings should be passed through Drupal.t().',
    ),
    array(
      '#type' => 'regex',
      '#value' => '#title\\s*=>\\s*[\'"][\'"]',
      '#warning_callback' => '_coder_review_i18n_fapi_title_without_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]form_error\\s*\\(\\s*' . $argex . '\\s*,\\s*[\'"]',
      '#warning_callback' => '_coder_review_i18n_form_error_without_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\'"]title[\'"]\\s*=>\\s*[\'"][^<]',
      '#warning_callback' => '_coder_review_i18n_in_hook_links_without_t',
      '#source' => 'allphp',
      '#function' => '_link$',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]drupal_set_title\\s*\\(\\s*[\'"]',
      '#warning_callback' => '_coder_review_i18n_drupal_set_title_without_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]drupal_set_message\\s*\\(\\s*[\'"]',
      '#warning_callback' => '_coder_review_i18n_drupal_set_message_without_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(]watchdog\\s*\\(\\s*' . $argex . '\\s*,\\s*(t|st)\\(',
      '#warning_callback' => '_coder_review_i18n_watchdog_with_t',
    ),
    // @NOTE: Add duplicate of the 6.x upgrade rule.
    array(
      '#type' => 'regex',
      '#function' => '_menu$',
      '#source' => 'allphp',
      '#value' => '\'title\'\\s*=>\\s*t\\(|\'description\'\\s*=>\\s*t\\(',
      '#warning_callback' => '_coder_review_i18n_menu_with_t',
    ),
    array(
      '#type' => 'regex',
      '#value' => '[\\s\\(](t|st)\\s*\\(\\s*[\'"](\\s+|[^\\)]*?\\s+[\'"]\\s*[,\\)])',
      '#not' => '[\\s\\(](t|st)\\s*\\(\\s*[\'"][^\\s].*?([\'"]\\s+[^,\\)])*.*[^\\s][\'"][,\\)]',
      '#source' => 'allphp',
      '#warning_callback' => '_coder_review_i18n_space_starts_or_ends_t',
    ),
  );
  $review = array(
    '#title' => t('Internationalization'),
    '#rules' => $rules,
  );
  return array(
    'i18n' => $review,
  );
}

/**
 * Define the warning callbacks.
 */
function _coder_review_i18n_l_without_t() {
  return array(
    '#warning' => t('The $text argument to !l() should be enclosed within !t() so that it is translatable.', array(
      '!l' => theme('drupalapi', array(
        'function' => 'l',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_in_install_l_without_st() {
  return array(
    '#warning' => t('The $text argument to !l() should be enclosed within !st() so that it is translatable from within the install.', array(
      '!l' => theme('drupalapi', array(
        'function' => 'l',
      )),
      '!st' => theme('drupalapi', array(
        'function' => 'st',
      )),
    )),
  );
}
function _coder_review_i18n_in_install_t() {
  return array(
    '#warning' => t('Use !st() instead of !t() in !hook_install(), !hook_uninstall() and !hook_update_N()', array(
      '!st' => theme('drupalapi', array(
        'function' => 'st',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
      '!hook_install' => theme('drupalapi', array(
        'function' => 'hook_install',
      )),
      '!hook_uninstall' => theme('drupalapi', array(
        'function' => 'hook_uninstall',
      )),
      '!hook_update_N' => theme('drupalapi', array(
        'function' => 'hook_update_N',
      )),
    )),
  );
}
function _coder_review_i18n_fapi_title_without_t() {
  return array(
    '#warning' => t('The FAPI #title should be enclosed within !t() so that it is translatable.', array(
      '!l' => theme('drupalapi', array(
        'function' => 'l',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_form_error_without_t() {
  return array(
    '#warning' => t('The $message argument to !form_error() should be enclosed within !t() so that it is translatable.', array(
      '!form_error' => theme('drupalapi', array(
        'function' => 'form_error',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_in_hook_links_without_t() {
  return array(
    '#warning' => t("The 'title' option should be enclosed within !t() so that it is translatable.", array(
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_drupal_set_message_without_t() {
  return array(
    '#warning' => t('The $message argument to !drupal_set_message() should be enclosed within !t() so that it is translatable.', array(
      '!drupal_set_message' => theme('drupalapi', array(
        'function' => 'drupal_set_message',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_drupal_set_title_without_t() {
  return array(
    '#warning' => t('The $title argument to !drupal_set_title() should be enclosed within !t() so that it is translatable.', array(
      '!drupal_set_title' => theme('drupalapi', array(
        'function' => 'drupal_set_title',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_watchdog_with_t() {
  return array(
    '#warning' => t('The $message argument to !watchdog() should NOT be enclosed within !t(), so that it can be properly translated at display time.', array(
      '!watchdog' => theme('drupalapi', array(
        'function' => 'watchdog',
      )),
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
  );
}
function _coder_review_i18n_menu_with_t() {
  return array(
    '#warning' => t('Menu item titles and descriptions should NOT be enclosed within !t().', array(
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
    '#link' => 'http://drupal.org/node/140311',
  );
}
function _coder_review_i18n_space_starts_or_ends_t() {
  return array(
    '#warning' => t('The $string argument to !t() should not begin or end with a space.', array(
      '!t' => theme('drupalapi', array(
        'function' => 't',
      )),
    )),
    '#link' => 'http://drupal.org/node/304150',
  );
}

Functions

Name	Description
coder_review_i18n_reviews	Implements hook_reviews().
_coder_review_i18n_drupal_set_message_without_t
_coder_review_i18n_drupal_set_title_without_t
_coder_review_i18n_fapi_title_without_t
_coder_review_i18n_form_error_without_t
_coder_review_i18n_in_hook_links_without_t
_coder_review_i18n_in_install_l_without_st
_coder_review_i18n_in_install_t
_coder_review_i18n_l_without_t	Define the warning callbacks.
_coder_review_i18n_menu_with_t
_coder_review_i18n_space_starts_or_ends_t
_coder_review_i18n_watchdog_with_t