class views_plugin_localization_core in Views (for Drupal 7) 6.3

Localization plugin to pass translatable strings through t().

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_localization
      • class \views_plugin_localization_core

1 string reference to 'views_plugin_localization_core'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_localization_core.inc, line 13

Contains the Drupal core localization plugin.

class views_plugin_localization_core extends views_plugin_localization {

  /**
   * Translate a string.
   *
   * @param $string
   *   The string to be translated.
   * @param $keys
   *   An array of keys to identify the string. Generally constructed from
   *   view name, display_id, and a property, e.g., 'header'.
   * @param $format
   *   The input format of the string. This is optional.
   */
  function translate_string($string, $keys = array(), $format = '') {
    return t($string);
  }

  /**
   * Save a string for translation.
   *
   * @param $string
   *   The string to be translated.
   * @param $keys
   *   An array of keys to identify the string. Generally constructed from
   *   view name, display_id, and a property, e.g., 'header'.
   * @param $format
   *   The input format of the string. This is optional.
   */
  function save_string($string, $keys = array(), $format = '') {
    global $language;

    // If the current language is 'en', we need to reset the language
    // in order to trigger an update.
    // TODO: add test for number of languages.
    if ($language->language == 'en') {
      $changed = TRUE;
      $languages = language_list();
      $cached_language = $language;
      unset($languages['en']);
      if (!empty($languages)) {
        $language = current($languages);
      }
    }
    t($string);
    if (isset($cached_language)) {
      $language = $cached_language;
    }
    return TRUE;
  }

  /**
   * Delete a string.
   *
   * Deletion is not supported.
   *
   * @param $source
   *   Full data for the string to be translated.
   */
  function delete($source) {
    return FALSE;
  }

  /**
   * Collect strings to be exported to code.
   *
   * String identifiers are not supported so strings are anonymously in an array.
   *
   * @param $source
   *   Full data for the string to be translated.
   */
  function export($source) {
    if (!empty($source['value'])) {
      $this->export_strings[] = $source['value'];
    }
  }

  /**
   * Render any collected exported strings to code.
   *
   * @param $indent
   *   An optional indentation for prettifying nested code.
   */
  function export_render($indent = '  ') {
    $output = '';
    if (!empty($this->export_strings)) {
      $this->export_strings = array_unique($this->export_strings);
      $output = $indent . '$translatables[\'' . $this->view->name . '\'] = array(' . "\n";
      foreach ($this->export_strings as $string) {
        $output .= $indent . "  t('" . str_replace("'", "\\'", $string) . "'),\n";
      }
      $output .= $indent . ");\n";
    }
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$definition		property	Handler's definition
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.	6
views_object::destroy		function		2
views_object::export_option		function		1
views_object::export_options		function
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::option_definition		function	Information about options for all kinds of purposes will be held here.	13
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable		function	Unpack a single option definition.
views_object::unpack_translatables		function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults		function
views_plugin::$display		property	The current used views display.
views_plugin::$plugin_type		property	The plugin type of this plugin, for example style or query.
views_plugin::$view		property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::options_form		function	Provide a form to edit options for this plugin.	13
views_plugin::options_submit		function	Handle any special handling on the validate form.	9
views_plugin::options_validate		function	Validate the options form.	8
views_plugin::query		function	Add anything to the query that we might need to.	7
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin::validate		function	Validate that the plugin is correct and can be saved.	2
views_plugin_localization::$export_strings		property
views_plugin_localization::$translate		property		2
views_plugin_localization::init		function	Initialize the plugin.
views_plugin_localization::invoke_translation_process		function	Invoke hook_translation_pre_process() or hook_translation_post_process().
views_plugin_localization::process_locale_strings		function
views_plugin_localization::save		function	Save string source for translation.	1
views_plugin_localization::translate		function	Translate a string / text with format	2
views_plugin_localization_core::delete		function	Delete a string. Overrides views_plugin_localization::delete
views_plugin_localization_core::export		function	Collect strings to be exported to code. Overrides views_plugin_localization::export
views_plugin_localization_core::export_render		function	Render any collected exported strings to code. Overrides views_plugin_localization::export_render
views_plugin_localization_core::save_string		function	Save a string for translation. Overrides views_plugin_localization::save_string
views_plugin_localization_core::translate_string		function	Translate a string. Overrides views_plugin_localization::translate_string