views_plugin_exposed_form.inc

<?php


/**
 * @file
 * Definition of views_plugin_exposed_form.
 */

/**
 * @defgroup views_exposed_form_plugins Views exposed form plugins
 * @{
 * Plugins that handle the validation/submission and rendering of exposed forms.
 *
 * If needed, it is possible to use them to add additional form elements.
 *
 * @see hook_views_plugins()
 */

/**
 * The base plugin to handle exposed filter forms.
 */
class views_plugin_exposed_form extends views_plugin {
    
    /**
     * Initialize the plugin.
     *
     * @param object $view
     *   The view object.
     * @param object $display
     *   The display handler.
     * @param array $options
     *   Any additional options that are being added.
     */
    public function init(&$view, &$display, $options = array()) {
        $this->view =& $view;
        $this->display =& $display;
        $this->unpack_options($this->options, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public 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['expose_sort_order'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['sort_asc_label'] = array(
            'default' => 'Asc',
            'translatable' => TRUE,
        );
        $options['sort_desc_label'] = array(
            'default' => 'Desc',
            'translatable' => TRUE,
        );
        $options['autosubmit'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['autosubmit_hide'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        parent::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,
                ),
            ),
        );
        $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['expose_sort_order'] = array(
            '#type' => 'checkbox',
            '#title' => t('Expose sort order'),
            '#description' => t('Allow the user to choose the sort order. If sort order is not exposed, the sort criteria settings for each sort will determine its order.'),
            '#default_value' => $this->options['expose_sort_order'],
        );
        $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,
            '#dependency' => array(
                'edit-exposed-form-options-expose-sort-order' => array(
                    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,
            '#dependency' => array(
                'edit-exposed-form-options-expose-sort-order' => array(
                    TRUE,
                ),
            ),
        );
        $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.
     */
    public 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,
            'always_process' => 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;
        $form = drupal_build_form('views_exposed_form', $form_state);
        if (!$this->view->display_handler
            ->displays_exposed() || !$block && $this->view->display_handler
            ->get_option('exposed_block')) {
            return "";
        }
        else {
            return drupal_render($form);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $view = $this->view;
        $exposed_data = isset($view->exposed_data) ? $view->exposed_data : array();
        $sort_by = isset($exposed_data['sort_by']) ? $exposed_data['sort_by'] : NULL;
        if (!empty($sort_by) && $this->view->style_plugin
            ->build_sort()) {
            // Make sure the original order of sorts is preserved
            // (e.g. a sticky sort is often first)
            if (isset($view->sort[$sort_by])) {
                $view->query->orderby = array();
                foreach ($view->sort as $key => $sort) {
                    if (!$sort->is_exposed()) {
                        $sort->query();
                    }
                    elseif ($key == $sort_by) {
                        if (isset($exposed_data['sort_order']) && in_array($exposed_data['sort_order'], array(
                            'ASC',
                            'DESC',
                        ))) {
                            $sort->options['order'] = $exposed_data['sort_order'];
                        }
                        $sort->set_relationship();
                        $sort->query();
                    }
                }
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function pre_render($values) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function post_render(&$output) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function pre_execute() {
    }
    
    /**
     * {@inheritdoc}
     */
    public function post_execute() {
    }
    
    /**
     * {@inheritdoc}
     */
    public 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)) {
            if (isset($form_state['input']['sort_by'])) {
                $sort_by = $form_state['input']['sort_by'];
            }
            else {
                $keys = array_keys($exposed_sorts);
                $sort_by = array_shift($keys);
            }
            if (isset($form_state['input']['sort_order'])) {
                $sort_order = $form_state['input']['sort_order'];
            }
            elseif (isset($this->view->sort[$sort_by])) {
                $sort_order = $this->view->sort[$sort_by]->options['order'];
            }
            else {
                $first_sort = reset($this->view->sort);
                $sort_order = $first_sort->options['order'];
            }
            if (!isset($form_state['input']['sort_by'])) {
                $form_state['input']['sort_by'] = $sort_by;
            }
            if (!isset($form_state['input']['sort_order'])) {
                $form_state['input']['sort_order'] = $sort_order;
            }
            $form['sort_by'] = array(
                '#type' => 'select',
                '#options' => $exposed_sorts,
                '#title' => $this->options['exposed_sorts_label'],
                '#default_value' => $sort_by,
            );
            $sort_options = array(
                'ASC' => $this->options['sort_asc_label'],
                'DESC' => $this->options['sort_desc_label'],
            );
            if ($this->options['expose_sort_order']) {
                $form['sort_order'] = array(
                    '#type' => 'select',
                    '#options' => $sort_options,
                    '#title' => t('Order', array(), array(
                        'context' => 'Sort order',
                    )),
                    '#default_value' => $sort_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 = array_merge_recursive($form, array(
                '#attributes' => array(
                    'class' => array(
                        'ctools-auto-submit-full-form',
                    ),
                ),
            ));
            $form['submit']['#attributes']['class'][] = 'ctools-use-ajax';
            $form['submit']['#attributes']['class'][] = 'ctools-auto-submit-click';
            $form['#attached']['js'][] = drupal_get_path('module', 'ctools') . '/js/auto-submit.js';
            if (!empty($this->options['autosubmit_hide'])) {
                $form['submit']['#attributes']['class'][] = 'js-hide';
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public 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 array $form
     *   Nested array of form elements that comprise the form.
     * @param array $form_state
     *   A keyed array containing the current state of the form.
     * @param array $exclude
     *   Nested array of keys to exclude of insert into $view->exposed_raw_input.
     */
    public 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';
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function reset_form(&$form, &$form_state) {
        // _SESSION is not defined for users who are not logged in.
        // 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;
        if (isset($_SESSION['views'][$this->view->name][$display_id])) {
            unset($_SESSION['views'][$this->view->name][$display_id]);
        }
        // Set the form to allow redirect.
        if (empty($this->view->live_preview)) {
            $form_state['no_redirect'] = FALSE;
        }
        else {
            $form_state['rebuild'] = TRUE;
            $this->view->exposed_data = array();
        }
        $form_state['redirect'] = current_path();
        $form_state['values'] = array();
    }

}

/**
 * @}
 */