class views_plugin_style_summary_jump_menu
- 3.x plugins/views_plugin_style_summary_jump_menu.inc views_plugin_style_summary_jump_menu
- 2.x plugins/views_plugin_style_summary_jump_menu.inc views_plugin_style_summary_jump_menu
The default style plugin for summaries.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of views_plugin_style_summary_jump_menu
Related topics
1 string reference to 'views_plugin_style_summary_jump_menu'
- views_views_plugins in includes/
plugins.inc - Implementation of hook_views_plugins
File
- plugins/
views_plugin_style_summary_jump_menu.inc, line 12 - Contains the default summary style plugin, which displays items in an HTML list.
View source
class views_plugin_style_summary_jump_menu extends views_plugin_style {
function option_definition() {
$options = parent::option_definition();
$options['base_path'] = array('default' => '');
$options['count'] = array('default' => TRUE);
$options['hide'] = array('default' => FALSE);
$options['text'] = array('default' => 'Go', 'translatable' => TRUE);
$options['choose'] = array('default' => '- Choose -', 'translatable' => TRUE);
$options['default_value'] = array('default' => FALSE);
return $options;
}
function query() {
// We can't have an offset without a limit, so provide a very large limit instead.
if (!empty($this->display->handler->options['offset'])) {
$this->view->set_items_per_page(999999);
}
else {
$this->view->set_items_per_page(0);
$this->view->set_use_pager(0);
}
}
function options_form(&$form, &$form_state) {
parent::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['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 argument setting will be displayed as the default option in the jump menu, if applicable.'),
);
}
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 = '';
foreach ($this->view->result as $id => $row) {
$args = $this->view->args;
$args[$argument->position] = $argument->summary_argument($row);
$base_path = NULL;
if (!empty($argument->options['style_options']['base_path'])) {
$base_path = $argument->options['style_options']['base_path'];
}
$path = url($this->view->get_url($args, $base_path), $url_options);
$options[$path] = strip_tags($argument->summary_name($row));
if (!empty($this->options['count'])) {
$options[$path] .= ' (' . intval($row->{$argument->count_alias}) . ')';
}
if ($this->options['default_value'] && $_GET['q'] == $this->view->get_url($args)) {
$default_value = $path;
}
}
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);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
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:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | ||
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | |
views_plugin:: |
function | Handle any special handling on the validate form. | |
views_plugin:: |
function | Validate the options form. | |
views_plugin:: |
function | Provide a full list of possible theme templates used by this style. | |
views_plugin_style:: |
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. | |
views_plugin_style:: |
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. | |
views_plugin_style:: |
function |
Overrides views_object:: |
|
views_plugin_style:: |
function | Get a rendered field. | |
views_plugin_style:: |
function |
Initialize a style plugin. Overrides views_plugin:: |
|
views_plugin_style:: |
function | Allow the style to do stuff before each row is rendered. | |
views_plugin_style:: |
function | Render all of the fields for a given style and store them on the object. | |
views_plugin_style:: |
function | Group records as needed for rendering. | |
views_plugin_style:: |
function | Return TRUE if this style also uses fields. | |
views_plugin_style:: |
function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
function |
Validate that the plugin is correct and can be saved. Overrides views_plugin:: |
|
views_plugin_style_summary_jump_menu:: |
function |
Provide a form to edit options for this plugin. Overrides views_plugin_style:: |
|
views_plugin_style_summary_jump_menu:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_plugin_style:: |
|
views_plugin_style_summary_jump_menu:: |
function |
Add anything to the query that we might need to. Overrides views_plugin_style:: |
|
views_plugin_style_summary_jump_menu:: |
function |
Render the display in this style. Overrides views_plugin_style:: |