class views_plugin_style_jump_menu
Style plugin to render each item as a row in a table.
Hierarchy
- class \views_object
- class \views_plugin extends \views_object
- class \views_plugin_style extends \views_plugin
- class \views_plugin_style_jump_menu extends \views_plugin_style
- class \views_plugin_style extends \views_plugin
- class \views_plugin extends \views_object
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 - Implements hook_views_plugins().
File
-
plugins/
views_plugin_style_jump_menu.inc, line 13
View source
class views_plugin_style_jump_menu extends views_plugin_style {
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['hide'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['path'] = array(
'default' => '',
);
$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;
}
/**
* Render the given style.
*/
public 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(
'#markup' => t('You need at least one field before you can configure your jump menu settings'),
'#prefix' => '<div class="error messages">',
'#suffix' => '</div>',
);
return;
}
$form['markup'] = array(
'#markup' => 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['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 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.
*/
public 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 = strip_tags(decode_entities($this->get_field($this->view->row_index, $this->options['path'])));
// Putting a '/' in front messes up url() so let's take that out
// so users don't shoot themselves in the foot.
$base_path = base_path();
if (strpos($path, $base_path) === 0) {
$path = drupal_substr($path, drupal_strlen($base_path));
}
// Use drupal_parse_url() to preserve query and fragment in case the
// user wants to do fun tricks.
$url_options = drupal_parse_url($path);
$path = url($url_options['path'], $url_options);
$field = strip_tags(decode_entities($this->row_plugin
->render($row)));
$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 (!empty($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'],
'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 $form;
}
}
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::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 | ||||
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_submit | public | function | Handle any special handling on the validate form. | 9 | ||
views_plugin::plugin_title | public | function | Return the human readable name of the display. | |||
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_style::$row_plugin | public | property | The row plugin, if it's initialized and the style itself supports it. | |||
views_plugin_style::$row_tokens | public | property | Store all available tokens row rows. | |||
views_plugin_style::build_sort | public | 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 | public | 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 | public | function | Destructor. | Overrides views_object::destroy | ||
views_plugin_style::even_empty | public | function | Should the output of the style plugin be rendered even if it's empty. | 1 | ||
views_plugin_style::get_field | public | function | Get a rendered field. | |||
views_plugin_style::get_field_value | public | function | Get the raw field value. | |||
views_plugin_style::get_row_class | public | function | Return the token replaced row class for the specified row. | |||
views_plugin_style::init | public | function | Initialize a style plugin. | |||
views_plugin_style::options_validate | public | function | Validate the options form. | Overrides views_plugin::options_validate | ||
views_plugin_style::pre_render | public | function | Allow the style to do stuff before each row is rendered. | |||
views_plugin_style::query | public | function | Add anything to the query that we might need to. | Overrides views_plugin::query | 2 | |
views_plugin_style::render_fields | public | function | Render all of the fields for a given style and store them on the object. | |||
views_plugin_style::render_grouping | public | function | Group records as needed for rendering. | |||
views_plugin_style::render_grouping_sets | public | function | Render the grouping sets. | |||
views_plugin_style::tokenize_value | public | function | Take a value and apply token replacement logic to it. | |||
views_plugin_style::uses_fields | public | function | Return TRUE if this style also uses fields. | |||
views_plugin_style::uses_row_class | public | function | Return TRUE if this style also uses a row plugin. | |||
views_plugin_style::uses_row_plugin | public | function | Return TRUE if this style also uses a row plugin. | |||
views_plugin_style::uses_tokens | public | function | Return TRUE if this style uses tokens. | |||
views_plugin_style::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides views_plugin::validate | ||
views_plugin_style_jump_menu::options_form | public | function | Render the given style. | Overrides views_plugin_style::options_form | ||
views_plugin_style_jump_menu::option_definition | public | 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 | public | function | Render the display in this style. | Overrides views_plugin_style::render |