class views_plugin_localization_core

Same name in other branches
  1. 6.x-3.x plugins/views_plugin_localization_core.inc \views_plugin_localization_core

Localization plugin to pass translatable strings through t().

Hierarchy

Expanded class hierarchy of views_plugin_localization_core

Related topics

1 string reference to 'views_plugin_localization_core'
views_views_plugins in includes/plugins.inc
Implements hook_views_plugins().

File

plugins/views_plugin_localization_core.inc, line 13

View source
class views_plugin_localization_core extends views_plugin_localization {
    
    /**
     * Translate a string.
     *
     * @param string $string
     *   The string to be translated.
     * @param array $keys
     *   An array of keys to identify the string. Generally constructed from
     *   view name, display_id, and a property, e.g., 'header'.
     * @param string $format
     *   The input format of the string. This is optional.
     */
    public function translate_string($string, $keys = array(), $format = '') {
        return t($string);
    }
    
    /**
     * Save a string for translation.
     *
     * @param string $string
     *   The string to be translated.
     * @param array $keys
     *   An array of keys to identify the string. Generally constructed from
     *   view name, display_id, and a property, e.g., 'header'.
     * @param string $format
     *   The input format of the string. This is optional.
     */
    public 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') {
            $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 mixed $source
     *   Full data for the string to be translated.
     */
    public 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 array $source
     *   Full data for the string to be translated.
     */
    public function export($source) {
        if (!empty($source['value'])) {
            $this->export_strings[] = $source['value'];
        }
    }
    
    /**
     * Render any collected exported strings to code.
     *
     * @param string $indent
     *   An optional indentation for prettifying nested code.
     */
    public 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

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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 public 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::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
views_plugin_localization_core::delete public function Delete a string. Overrides views_plugin_localization::delete
views_plugin_localization_core::export public function Collect strings to be exported to code. Overrides views_plugin_localization::export
views_plugin_localization_core::export_render public function Render any collected exported strings to code. Overrides views_plugin_localization::export_render
views_plugin_localization_core::save_string public function Save a string for translation. Overrides views_plugin_localization::save_string
views_plugin_localization_core::translate_string public function Translate a string. Overrides views_plugin_localization::translate_string