views_plugin_style_summary_jump_menu.inc

Same filename in other branches
  1. 6.x-3.x plugins/views_plugin_style_summary_jump_menu.inc

Definition of views_plugin_style_summary_jump_menu.

File

plugins/views_plugin_style_summary_jump_menu.inc

View source
<?php


/**
 * @file
 * Definition of views_plugin_style_summary_jump_menu.
 */

/**
 * The default style plugin for summaries.
 *
 * @ingroup views_style_plugins
 */
class views_plugin_style_summary_jump_menu extends views_plugin_style {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['base_path'] = array(
            'default' => '',
        );
        $options['count'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['hide'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['text'] = array(
            'default' => 'Go',
            'translatable' => TRUE,
        );
        $options['label'] = array(
            'default' => '',
            'translatable' => TRUE,
        );
        $options['choose'] = array(
            'default' => '- Choose -',
            'translatable' => TRUE,
        );
        $options['inline'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['default_value'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        // Copy the offset option.
        $pager = array(
            'type' => 'none',
            'options' => $this->display->handler->options['pager']['options'],
        );
        $this->display->handler
            ->set_option('pager', $pager);
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        $form['base_path'] = array(
            '#type' => 'textfield',
            '#title' => t('Base path'),
            '#default_value' => $this->options['base_path'],
            '#description' => t('Define the base path for links in this summary
        view, i.e. http://example.com/<strong>your_view_path/archive</strong>.
        Do not include beginning and ending forward slash. If this value
        is empty, views will use the first path found as the base path,
        in page displays, or / if no path could be found.'),
        );
        $form['count'] = array(
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['count']),
            '#title' => t('Display record count with link'),
        );
        $form['hide'] = array(
            '#type' => 'checkbox',
            '#title' => t('Hide the "Go" button'),
            '#default_value' => !empty($this->options['hide']),
            '#description' => t('If hidden, this button will only be hidden for users with JavaScript and the page will automatically jump when the select is changed.'),
        );
        $form['text'] = array(
            '#type' => 'textfield',
            '#title' => t('Button text'),
            '#default_value' => $this->options['text'],
        );
        $form['label'] = array(
            '#type' => 'textfield',
            '#title' => t('Selector label'),
            '#default_value' => $this->options['label'],
            '#description' => t('The text that will appear as the label of the selector element. If blank no label tag will be used.'),
        );
        $form['choose'] = array(
            '#type' => 'textfield',
            '#title' => t('Choose text'),
            '#default_value' => $this->options['choose'],
            '#description' => t('The text that will appear as the selected option in the jump menu.'),
        );
        $form['inline'] = array(
            '#type' => 'checkbox',
            '#title' => t('Set this field to display inline'),
            '#default_value' => !empty($this->options['inline']),
        );
        $form['default_value'] = array(
            '#type' => 'checkbox',
            '#title' => t('Select the current contextual filter value'),
            '#default_value' => !empty($this->options['default_value']),
            '#description' => t('If checked, the current contextual filter value will be displayed as the default option in the jump menu, if applicable.'),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        $argument = $this->view->argument[$this->view->build_info['summary_level']];
        $url_options = array();
        if (!empty($this->view->exposed_raw_input)) {
            $url_options['query'] = $this->view->exposed_raw_input;
        }
        $options = array();
        $default_value = '';
        $row_args = array();
        foreach ($this->view->result as $id => $row) {
            $row_args[$id] = $argument->summary_argument($row);
        }
        $argument->process_summary_arguments($row_args);
        foreach ($this->view->result as $id => $row) {
            $args = $this->view->args;
            $args[$argument->position] = $row_args[$id];
            $base_path = NULL;
            if (!empty($argument->options['summary_options']['base_path'])) {
                $base_path = $argument->options['summary_options']['base_path'];
            }
            $path = url($this->view
                ->get_url($args, $base_path), $url_options);
            $summary_value = strip_tags($argument->summary_name($row));
            $key = md5($path . $summary_value) . "::" . $path;
            $options[$key] = $summary_value;
            if (!empty($this->options['count'])) {
                $options[$key] .= ' (' . intval($row->{$argument->count_alias}) . ')';
            }
            if ($this->options['default_value'] && $_GET['q'] == $this->view
                ->get_url($args)) {
                $default_value = $key;
            }
        }
        ctools_include('jump-menu');
        $settings = array(
            'hide' => $this->options['hide'],
            'button' => $this->options['text'],
            'title' => $this->options['label'],
            'choose' => $this->options['choose'],
            'inline' => $this->options['inline'],
            'default_value' => $default_value,
        );
        $form = drupal_get_form('ctools_jump_menu', $options, $settings);
        return drupal_render($form);
    }

}

Classes

Title Deprecated Summary
views_plugin_style_summary_jump_menu The default style plugin for summaries.