class i18nviews_plugin_localization_i18nstrings in Internationalization Views 7.3

Localization plugin to pass translatable strings through i18n_string().

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_localization
      • class \i18nviews_plugin_localization_i18nstrings

1 string reference to 'i18nviews_plugin_localization_i18nstrings'

i18nviews_views_plugins in includes/i18nviews.views.inc

Implementation of hook_views_plugins().

File

includes/i18nviews_plugin_localization_i18nstrings.inc, line 12

Contains the i18nstrings localization plugin.

class i18nviews_plugin_localization_i18nstrings 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 = '') {
    $options = array();
    $options['format'] = $format ? $format : I18N_STRING_FILTER_XSS_ADMIN;
    return i18n_string($this
      ->stringid($keys), $string, $options);
  }

  /**
   * 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 = '') {
    $options = array();
    $options['format'] = $format ? $format : I18N_STRING_FILTER_XSS_ADMIN;
    i18n_string_update($this
      ->stringid($keys), $string, $options);
  }

  /**
   * Delete a string.
   *
   * @param $source
   *   Full data for the string to be translated.
   */
  function delete($source) {
    i18n_string_remove($this
      ->stringid($source['keys']), $source['value']);
    return TRUE;
  }

  /**
   * Get string id for i18n
   *
   * @param $keys
   *   Array of keys for the string to be translated.
   */
  function stringid($keys) {
    foreach ($keys as $key => $value) {
      if (is_array($value)) {
        $keys[$key] = implode(':', $value);
      }
    }
    return 'views:' . implode(':', $keys);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
i18nviews_plugin_localization_i18nstrings::delete		function	Delete a string. Overrides views_plugin_localization::delete
i18nviews_plugin_localization_i18nstrings::save_string		function	Save a string for translation Overrides views_plugin_localization::save_string
i18nviews_plugin_localization_i18nstrings::stringid		function	Get string id for i18n
i18nviews_plugin_localization_i18nstrings::translate_string		function	Translate a string. Overrides views_plugin_localization::translate_string
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::option_definition	public	function	Information about options for all kinds of purposes will be held here.	13
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::options_form	public	function	Provide a form to edit options for this plugin.	13
views_plugin::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::options_validate	public	function	Validate the options form.	10
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::query	public	function	Add anything to the query that we might need to.	7
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_localization::$export_strings	public	property	Store for exported strings.
views_plugin_localization::$translate	public	property		2
views_plugin_localization::export	public	function	Collect strings to be exported to code.	2
views_plugin_localization::export_render	public	function	Render any collected exported strings to code.	1
views_plugin_localization::init	public	function	Initialize the plugin.
views_plugin_localization::invoke_translation_process	public	function	Invoke hook_translation_pre_process() or hook_translation_post_process().
views_plugin_localization::process_locale_strings	public	function
views_plugin_localization::save	public	function	Save string source for translation.	1
views_plugin_localization::translate	public	function	Translate a string / text with format.	2