class views_plugin_exposed_form
Same name in other branches
- 7.x-3.x plugins/views_plugin_exposed_form.inc \views_plugin_exposed_form
The base plugin to handle exposed filter forms.
Hierarchy
- class \views_object
- class \views_plugin extends \views_object
- class \views_plugin_exposed_form extends \views_plugin
- class \views_plugin extends \views_object
Expanded class hierarchy of views_plugin_exposed_form
1 string reference to 'views_plugin_exposed_form'
- views_views_plugins in includes/
plugins.inc - Implementation of hook_views_plugins
File
-
plugins/
views_plugin_exposed_form.inc, line 6
View source
class views_plugin_exposed_form extends views_plugin {
/**
* Initialize the plugin.
*
* @param $view
* The view object.
* @param $display
* The display handler.
*/
function init(&$view, &$display, $options = array()) {
$this->view =& $view;
$this->display =& $display;
$this->unpack_options($this->options, $options);
}
/**
* Return a string to display as the clickable title for the
* control.
*/
function summary_title() {
return t('Unknown');
}
function option_definition() {
$options = parent::option_definition();
$options['submit_button'] = array(
'default' => 'Apply',
'translatable' => TRUE,
);
$options['reset_button'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['reset_button_label'] = array(
'default' => 'Reset',
'translatable' => TRUE,
);
$options['exposed_sorts_label'] = array(
'default' => 'Sort by',
'translatable' => TRUE,
);
$options['sort_asc_label'] = array(
'default' => 'Asc',
'translatable' => TRUE,
);
$options['sort_desc_label'] = array(
'default' => 'Desc',
'translatable' => TRUE,
);
if (module_exists('ctools')) {
$options['autosubmit'] = array(
'default' => FALSE,
);
$options['autosubmit_hide'] = array(
'default' => FALSE,
);
}
return $options;
}
function options_form(&$form, &$form_state) {
$form['submit_button'] = array(
'#type' => 'textfield',
'#title' => t('Submit button text'),
'#description' => t('Text to display in the submit button of the exposed form.'),
'#default_value' => $this->options['submit_button'],
'#required' => TRUE,
);
$form['reset_button'] = array(
'#type' => 'checkbox',
'#title' => t('Include reset button'),
'#description' => t('If checked the exposed form will provide a button to reset all the applied exposed filters'),
'#default_value' => $this->options['reset_button'],
);
$form['reset_button_label'] = array(
'#type' => 'textfield',
'#title' => t('Reset button label'),
'#description' => t('Text to display in the reset button of the exposed form.'),
'#default_value' => $this->options['reset_button_label'],
'#required' => TRUE,
'#dependency' => array(
'edit-exposed-form-options-reset-button' => array(
1,
),
),
'#process' => array(
'views_process_dependency',
),
);
$form['exposed_sorts_label'] = array(
'#type' => 'textfield',
'#title' => t('Exposed sorts label'),
'#description' => t('Text to display as the label of the exposed sort select box.'),
'#default_value' => $this->options['exposed_sorts_label'],
'#required' => TRUE,
);
$form['sort_asc_label'] = array(
'#type' => 'textfield',
'#title' => t('Ascending'),
'#description' => t('Text to use when exposed sort is ordered ascending.'),
'#default_value' => $this->options['sort_asc_label'],
'#required' => TRUE,
);
$form['sort_desc_label'] = array(
'#type' => 'textfield',
'#title' => t('Descending'),
'#description' => t('Text to use when exposed sort is ordered descending.'),
'#default_value' => $this->options['sort_desc_label'],
'#required' => TRUE,
);
if (module_exists('ctools')) {
$form['autosubmit'] = array(
'#type' => 'checkbox',
'#title' => t('Autosubmit'),
'#description' => t('Automatically submit the form once an element is changed.'),
'#default_value' => $this->options['autosubmit'],
);
$form['autosubmit_hide'] = array(
'#type' => 'checkbox',
'#title' => t('Hide submit button'),
'#description' => t('Hide submit button if javascript is enabled.'),
'#default_value' => $this->options['autosubmit_hide'],
'#dependency' => array(
'edit-exposed-form-options-autosubmit' => array(
1,
),
),
);
}
}
/**
* Render the exposed filter form.
*
* This actually does more than that; because it's using FAPI, the form will
* also assign data to the appropriate handlers for use in building the
* query.
*/
function render_exposed_form($block = FALSE) {
// Deal with any exposed filters we may have, before building.
$form_state = array(
'view' => &$this->view,
'display' => &$this->display,
'method' => 'get',
'rerender' => TRUE,
'no_redirect' => TRUE,
);
// Some types of displays (eg. attachments) may wish to use the exposed
// filters of their parent displays instead of showing an additional
// exposed filter form for the attachment as well as that for the parent.
if (!$this->view->display_handler
->displays_exposed() || !$block && $this->view->display_handler
->get_option('exposed_block')) {
unset($form_state['rerender']);
}
if (!empty($this->ajax)) {
$form_state['ajax'] = TRUE;
}
$form_state['exposed_form_plugin'] = $this;
$output = drupal_build_form('views_exposed_form', $form_state);
if (!empty($form_state['js settings'])) {
$this->view->js_settings = $form_state['js settings'];
}
if (!$this->view->display_handler
->displays_exposed() || !$block && $this->view->display_handler
->get_option('exposed_block')) {
return "";
}
else {
return $output;
}
}
function query() {
$view = $this->view;
$exposed_data = $view->exposed_data;
if (!empty($exposed_data['sort_by'])) {
$handler = $view->sort[$exposed_data['sort_by']];
if (isset($handler)) {
$view->query->orderby = array();
if (isset($exposed_data['sort_order']) && in_array($exposed_data['sort_order'], array(
'ASC',
'DESC',
))) {
$handler->options['order'] = $exposed_data['sort_order'];
}
$handler->query();
foreach ($view->sort as $sort) {
if (!$sort->is_exposed()) {
$sort->query();
}
}
}
}
}
function pre_render(&$values) {
}
function post_render(&$output) {
}
function pre_execute() {
}
function exposed_form_alter(&$form, &$form_state) {
if (!empty($this->options['reset_button'])) {
$form['reset'] = array(
'#value' => $this->options['reset_button_label'],
'#type' => 'submit',
);
}
$form['submit']['#value'] = $this->options['submit_button'];
// Check if there is exposed sorts for this view
$exposed_sorts = array();
foreach ($this->view->sort as $id => $handler) {
if ($handler->can_expose() && $handler->is_exposed()) {
$exposed_sorts[$id] = check_plain($handler->options['expose']['label']);
}
}
if (count($exposed_sorts)) {
$form['sort_by'] = array(
'#type' => 'select',
'#options' => $exposed_sorts,
'#title' => $this->options['exposed_sorts_label'],
);
$sort_order = array(
'ASC' => $this->options['sort_asc_label'],
'DESC' => $this->options['sort_desc_label'],
);
$first_sort = reset($this->view->sort);
$form['sort_order'] = array(
'#type' => 'select',
'#options' => $sort_order,
'#title' => t('Order'),
'#default_value' => $first_sort->options['order'],
);
$form['submit']['#weight'] = 10;
if (isset($form['reset'])) {
$form['reset']['#weight'] = 10;
}
}
$pager = $this->view->display_handler
->get_plugin('pager');
if ($pager) {
$pager->exposed_form_alter($form, $form_state);
$form_state['pager_plugin'] = $pager;
}
// Apply autosubmit values.
if (!empty($this->options['autosubmit'])) {
$form['#attributes']['class'] .= ' ctools-auto-submit-full-form';
$form['submit']['#attributes']['class'] = 'ctools-use-ajax ctools-auto-submit-click';
ctools_add_js('auto-submit');
if (!empty($this->options['autosubmit_hide'])) {
$form['submit']['#attributes']['class'] .= ' js-hide';
}
}
}
function exposed_form_validate(&$form, &$form_state) {
if (isset($form_state['pager_plugin'])) {
$form_state['pager_plugin']->exposed_form_validate($form, $form_state);
}
}
/**
* This function is executed when exposed form is submited.
*
* @param $form
* Nested array of form elements that comprise the form.
* @param $form_state
* A keyed array containing the current state of the form.
* @param $exclude
* Nested array of keys to exclude of insert into
* $view->exposed_raw_input
*/
function exposed_form_submit(&$form, &$form_state, &$exclude) {
if (!empty($form_state['values']['op']) && $form_state['values']['op'] == $this->options['reset_button_label']) {
$this->reset_form($form, $form_state);
}
if (isset($form_state['pager_plugin'])) {
$form_state['pager_plugin']->exposed_form_submit($form, $form_state, $exclude);
$exclude[] = 'pager_plugin';
}
}
/**
* Provide a reset form if one was requested.
*/
function reset_form(&$form, &$form_state) {
// If filters are not overridden, store the 'remember' settings on the
// default display. If they are, store them on this display. This way,
// multiple displays in the same view can share the same filters and
// remember settings.
$display_id = $this->view->display_handler
->is_defaulted('filters') ? 'default' : $this->view->current_display;
unset($_SESSION['views'][$this->view->name][$display_id]);
$form_state['no_redirect'] = FALSE;
$form_state['redirect'] = !empty($this->view->ajax_path) ? $this->view->ajax_path : $_GET['q'];
}
}
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::destroy | function | 2 | |||
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::validate | function | Validate that the plugin is correct and can be saved. | 2 | ||
views_plugin_exposed_form::exposed_form_alter | function | ||||
views_plugin_exposed_form::exposed_form_submit | function | This function is executed when exposed form is submited. | |||
views_plugin_exposed_form::exposed_form_validate | function | ||||
views_plugin_exposed_form::init | function | Initialize the plugin. | |||
views_plugin_exposed_form::options_form | function | Provide a form to edit options for this plugin. | Overrides views_plugin::options_form | 1 | |
views_plugin_exposed_form::option_definition | function | Information about options for all kinds of purposes will be held here. | Overrides views_object::option_definition | 1 | |
views_plugin_exposed_form::post_render | function | ||||
views_plugin_exposed_form::pre_execute | function | ||||
views_plugin_exposed_form::pre_render | function | 1 | |||
views_plugin_exposed_form::query | function | Add anything to the query that we might need to. | Overrides views_plugin::query | 1 | |
views_plugin_exposed_form::render_exposed_form | function | Render the exposed filter form. | |||
views_plugin_exposed_form::reset_form | function | Provide a reset form if one was requested. | |||
views_plugin_exposed_form::summary_title | function | Return a string to display as the clickable title for the control. |
2 |