class views_handler_relationship_translation

Handles relationships for content translation sets and provides multiple options.

Hierarchy

Expanded class hierarchy of views_handler_relationship_translation

Related topics

Views relationship handlers
Handlers to tell Views how to create alternate relationships.
1 string reference to 'views_handler_relationship_translation'
translation_views_data_alter in modules/translation.views.inc
Implements hook_views_data_alter().

File

modules/translation/views_handler_relationship_translation.inc, line 14

View source 
class views_handler_relationship_translation extends views_handler_relationship {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['language'] = array(
            'default' => 'current',
        );
        return $options;
    }
    
    /**
     * Add a translation selector.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $options = array(
            'all' => t('All'),
            'current' => t('Current language'),
            'default' => t('Default language'),
        );
        $options = array_merge($options, views_language_list());
        $form['language'] = array(
            '#type' => 'select',
            '#options' => $options,
            '#default_value' => $this->options['language'],
            '#title' => t('Translation option'),
            '#description' => t('The translation options allows you to select which translation or translations in a translation set join on. Select "Current language" or "Default language" to join on the translation in the current or default language respectively. Select a specific language to join on a translation in that language. If you select "All", each translation will create a new row, which may appear to cause duplicates.'),
        );
    }
    
    /**
     * Called to implement a relationship in a query.
     */
    public function query() {
        // Figure out what base table this relationship brings to the party.
        $table_data = views_fetch_data($this->definition['base']);
        $base_field = empty($this->definition['base field']) ? $table_data['table']['base']['field'] : $this->definition['base field'];
        $this->ensure_my_table();
        $def = $this->definition;
        $def['table'] = $this->definition['base'];
        $def['field'] = $base_field;
        $def['left_table'] = $this->table_alias;
        $def['left_field'] = $this->field;
        if (!empty($this->options['required'])) {
            $def['type'] = 'INNER';
        }
        $def['extra'] = array();
        if ($this->options['language'] != 'all') {
            switch ($this->options['language']) {
                case 'current':
                    $def['extra'][] = array(
                        'field' => 'language',
                        'value' => '***CURRENT_LANGUAGE***',
                    );
                    break;
                case 'default':
                    $def['extra'][] = array(
                        'field' => 'language',
                        'value' => '***DEFAULT_LANGUAGE***',
                    );
                    break;
                // Other values will be the language codes.
                default:
                    $def['extra'][] = array(
                        'field' => 'language',
                        'value' => $this->options['language'],
                    );
                    break;
            }
        }
        if (!empty($def['join_handler']) && class_exists($def['join_handler'])) {
            $join = new $def['join_handler']();
        }
        else {
            $join = new views_join();
        }
        $join->definition = $def;
        $join->extra = "(%alias.tnid != 0  OR ({$def['left_table']}.tnid = 0 AND %alias.nid = {$def['left_table']}.nid))";
        $join->construct();
        $join->adjusted = TRUE;
        // Use a short alias for this.
        $alias = $def['table'] . '_' . $this->table;
        $this->alias = $this->query
            ->add_relationship($alias, $join, $this->definition['base'], $this->relationship);
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different
on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::admin_summary public function Provide text for the administrative summary. 4
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used
a lot. 		8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped
on. 		2
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage.
There is no need for this function to actually store the data.
views_handler::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. 		1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. 		1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements
to let users modify the view.
views_handler::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times.
This is TRUE when exposed filters grouped are using checkboxes as
widgets. 		1
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_submit public function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. 		5
views_handler::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship
it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_relationship::init public function Let relationships live on tables other than the table they operate on. Overrides views_handler::init 2
views_handler_relationship::label public function Get this field's label.
views_handler_relationship::use_group_by public function You can't groupby a relationship. Overrides views_handler::use_group_by
views_handler_relationship_translation::options_form public function Add a translation selector. Overrides views_handler_relationship::options_form
views_handler_relationship_translation::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_relationship::option_definition
views_handler_relationship_translation::query public function Called to implement a relationship in a query. Overrides views_handler_relationship::query
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::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