class views_plugin_style_jump_menu

Same name in other branches
  1. 7.x-3.x plugins/views_plugin_style_jump_menu.inc \views_plugin_style_jump_menu

Style plugin to render each item as a row in a table.

Hierarchy

Expanded class hierarchy of views_plugin_style_jump_menu

Related topics

1 string reference to 'views_plugin_style_jump_menu'
views_views_plugins in includes/plugins.inc
Implementation of hook_views_plugins

File

plugins/views_plugin_style_jump_menu.inc, line 12

View source
class views_plugin_style_jump_menu extends views_plugin_style {
    function option_definition() {
        $options = parent::option_definition();
        $options['hide'] = array(
            'default' => FALSE,
        );
        $options['path'] = array(
            'default' => '',
        );
        $options['text'] = array(
            'default' => 'Go',
            'translatable' => TRUE,
        );
        $options['choose'] = array(
            'default' => '- Choose -',
            'translatable' => TRUE,
        );
        $options['default_value'] = array(
            'default' => FALSE,
        );
        return $options;
    }
    
    /**
     * Render the given style.
     */
    function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $handlers = $this->display->handler
            ->get_handlers('field');
        if (empty($handlers)) {
            $form['error_markup'] = array(
                '#value' => t('You need at least one field before you can configure your jump menu settings'),
                '#prefix' => '<div class="error form-item description">',
                '#suffix' => '</div>',
            );
            return;
        }
        $form['markup'] = array(
            '#value' => t('To properly configure a jump menu, you must select one field that will represent the path to utilize. You should then set that field to exclude. All other displayed fields will be part of the menu. Please note that all HTML will be stripped from this output as select boxes cannot show HTML.'),
            '#prefix' => '<div class="form-item description">',
            '#suffix' => '</div>',
        );
        foreach ($handlers as $id => $handler) {
            $options[$id] = $handler->ui_name();
        }
        $form['path'] = array(
            '#type' => 'select',
            '#title' => t('Path field'),
            '#options' => $options,
            '#default_value' => $this->options['path'],
        );
        $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['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['default_value'] = array(
            '#type' => 'checkbox',
            '#title' => t('Select the current argument'),
            '#default_value' => !empty($this->options['default_value']),
            '#description' => t('If checked, the current path will be displayed as the default option in the jump menu, if applicable.'),
        );
    }
    
    /**
     * Render the display in this style.
     *
     * This is overridden so that we can render our grouping specially.
     */
    function render() {
        $sets = $this->render_grouping($this->view->result, $this->options['grouping']);
        // Turn this all into an $options array for the jump menu.
        $this->view->row_index = 0;
        $options = array();
        $paths = array();
        foreach ($sets as $title => $records) {
            foreach ($records as $row_index => $row) {
                $this->view->row_index = $row_index;
                $path = html_entity_decode(strip_tags($this->get_field($this->view->row_index, $this->options['path'])), ENT_QUOTES);
                // Putting a '/' in front messes up url() so let's take that out
                // so users don't shoot themselves in the foot.
                if (strpos($path, '/') === 0) {
                    $path = substr($path, 1);
                }
                // use parse_url() to preserve query and fragment in case the user
                // wants to do fun tricks.
                $url = parse_url($path);
                $url_options = array();
                if (isset($url['query'])) {
                    $path = strtr($path, array(
                        '?' . $url['query'] => '',
                    ));
                    $url_options['query'] = $url['query'];
                }
                if (isset($url['fragment'])) {
                    $path = strtr($path, array(
                        '#' . $url['fragment'] => '',
                    ));
                    $url_options['fragment'] = $url['fragment'];
                }
                $path = url($path, $url_options);
                $field = html_entity_decode(strip_tags($this->row_plugin
                    ->render($row)), ENT_QUOTES);
                $key = md5($path . $field) . "::" . $path;
                if ($title) {
                    $options[$title][$key] = $field;
                }
                else {
                    $options[$key] = $field;
                }
                $paths[$path] = $key;
                $this->view->row_index++;
            }
        }
        unset($this->view->row_index);
        $default_value = '';
        if ($this->options['default_value']) {
            $lookup_options = array();
            // We need to check if the path is absolute
            // or else language is not taken in account.
            if ($this->view->display[$this->view->current_display]->display_options['fields'][$this->options['path']]['absolute']) {
                $lookup_options['absolute'] = TRUE;
            }
            $lookup_url = url($_GET['q'], $lookup_options);
            if (!empty($paths[$lookup_url])) {
                $default_value = $paths[$lookup_url];
            }
        }
        ctools_include('jump-menu');
        $settings = array(
            'hide' => $this->options['hide'],
            'button' => $this->options['text'],
            'choose' => $this->options['choose'],
            'default_value' => $default_value,
        );
        return drupal_get_form('ctools_jump_menu', $options, $settings);
    }
    function render_set($title, $records) {
        $options = array();
        $fields = $this->rendered_fields;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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::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::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_submit function Handle any special handling on the validate form. 9
views_plugin::options_validate function Validate the options form. 8
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin property Contains the row plugin, if it's initialized
and the style itself supports it.
views_plugin_style::$row_tokens property Store all availible tokens row rows.
views_plugin_style::build_sort function Called by the view builder to see if this style handler wants to
interfere with the sorts. If so it should build; if it returns
any non-TRUE value, normal sorting will NOT be added to the query.
1
views_plugin_style::build_sort_post function Called by the view builder to let the style build a second set of
sorts that will come after any other sorts in the view.
1
views_plugin_style::destroy function Overrides views_object::destroy
views_plugin_style::even_empty function Should the output of the style plugin be rendered even if it's a empty view. 1
views_plugin_style::get_field function Get a rendered field.
views_plugin_style::get_row_class function Return the token replaced row class for the specified row.
views_plugin_style::init function Initialize a style plugin.
views_plugin_style::pre_render function Allow the style to do stuff before each row is rendered.
views_plugin_style::query function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render_fields function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping function Group records as needed for rendering.
views_plugin_style::tokenize_value function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens function Return TRUE if this style uses tokens.
views_plugin_style::validate function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_jump_menu::options_form function Render the given style. Overrides views_plugin_style::options_form
views_plugin_style_jump_menu::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
views_plugin_style_jump_menu::render function Render the display in this style. Overrides views_plugin_style::render
views_plugin_style_jump_menu::render_set function