class views_handler_sort

Base sort handler that has no options and performs a simple sort.

Hierarchy

Expanded class hierarchy of views_handler_sort

Related topics

18 string references to 'views_handler_sort'
aggregator_views_data in modules/aggregator.views.inc
Implements hook_views_data().
book_views_data in modules/book.views.inc
Implements hook_views_data().
comment_views_data in modules/comment.views.inc
Implements hook_views_data().
comment_views_data_alter in modules/comment.views.inc
Implements hook_views_data_alter() on behalf of comment.module.
field_views_field_default_views_data in modules/field.views.inc
Default views data implementation for a field.

... See full list

File

handlers/views_handler_sort.inc, line 19

View source
class views_handler_sort extends views_handler {
    
    /**
     * Determine if a sort can be exposed.
     */
    public function can_expose() {
        return TRUE;
    }
    
    /**
     * Called to add the sort to a query.
     */
    public function query() {
        $this->ensure_my_table();
        // Add the field.
        $this->query
            ->add_orderby($this->table_alias, $this->real_field, $this->options['order']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['order'] = array(
            'default' => 'ASC',
        );
        $options['exposed'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['expose'] = array(
            'contains' => array(
                'label' => array(
                    'default' => '',
                    'translatable' => TRUE,
                ),
            ),
        );
        return $options;
    }
    
    /**
     * Display whether or not the sort order is ascending or descending.
     */
    public function admin_summary() {
        if (!empty($this->options['exposed'])) {
            return t('Exposed');
        }
        switch ($this->options['order']) {
            case 'ASC':
            case 'asc':
            default:
                return t('asc');
            case 'DESC':
            case 'desc':
                return t('desc');
        }
    }
    
    /**
     * Basic options for all sort criteria.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        if ($this->can_expose()) {
            $this->show_expose_button($form, $form_state);
        }
        $form['op_val_start'] = array(
            '#value' => '<div class="clearfix">',
        );
        $this->show_sort_form($form, $form_state);
        $form['op_val_end'] = array(
            '#value' => '</div>',
        );
        if ($this->can_expose()) {
            $this->show_expose_form($form, $form_state);
        }
    }
    
    /**
     * Shortcut to display the expose/hide button.
     */
    public function show_expose_button(&$form, &$form_state) {
        $form['expose_button'] = array(
            '#prefix' => '<div class="views-expose clearfix">',
            '#suffix' => '</div>',
            // Should always come first.
'#weight' => -1000,
        );
        // Add a checkbox for JS users, which will have behavior attached to it
        // so it can replace the button.
        $form['expose_button']['checkbox'] = array(
            '#theme_wrappers' => array(
                'container',
            ),
            '#attributes' => array(
                'class' => array(
                    'js-only',
                ),
            ),
        );
        $form['expose_button']['checkbox']['checkbox'] = array(
            '#title' => t('Expose this sort to visitors, to allow them to change it'),
            '#type' => 'checkbox',
        );
        // Then add the button itself.
        if (empty($this->options['exposed'])) {
            $form['expose_button']['markup'] = array(
                '#markup' => '<div class="description exposed-description" style="float: left; margin-right:10px">' . t('This sort is not exposed. Expose it to allow the users to change it.') . '</div>',
            );
            $form['expose_button']['button'] = array(
                '#limit_validation_errors' => array(),
                '#type' => 'submit',
                '#value' => t('Expose sort'),
                '#submit' => array(
                    'views_ui_config_item_form_expose',
                ),
            );
            $form['expose_button']['checkbox']['checkbox']['#default_value'] = 0;
        }
        else {
            $form['expose_button']['markup'] = array(
                '#markup' => '<div class="description exposed-description">' . t('This sort is exposed. If you hide it, users will not be able to change it.') . '</div>',
            );
            $form['expose_button']['button'] = array(
                '#limit_validation_errors' => array(),
                '#type' => 'submit',
                '#value' => t('Hide sort'),
                '#submit' => array(
                    'views_ui_config_item_form_expose',
                ),
            );
            $form['expose_button']['checkbox']['checkbox']['#default_value'] = 1;
        }
    }
    
    /**
     * Simple validate handler.
     */
    public function options_validate(&$form, &$form_state) {
        $this->sort_validate($form, $form_state);
        if (!empty($this->options['exposed'])) {
            $this->expose_validate($form, $form_state);
        }
    }
    
    /**
     * Simple submit handler.
     */
    public function options_submit(&$form, &$form_state) {
        // Don't store this.
        unset($form_state['values']['expose_button']);
        $this->sort_submit($form, $form_state);
        if (!empty($this->options['exposed'])) {
            $this->expose_submit($form, $form_state);
        }
    }
    
    /**
     * Shortcut to display the value form.
     */
    public function show_sort_form(&$form, &$form_state) {
        $options = $this->sort_options();
        if (!empty($options)) {
            $form['order'] = array(
                '#type' => 'radios',
                '#options' => $options,
                '#default_value' => $this->options['order'],
            );
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function sort_validate(&$form, &$form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function sort_submit(&$form, &$form_state) {
    }
    
    /**
     * Provide a list of options for the default sort form.
     *
     * Should be overridden by classes that don't override sort_form.
     */
    public function sort_options() {
        return array(
            'ASC' => t('Sort ascending'),
            'DESC' => t('Sort descending'),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function expose_form(&$form, &$form_state) {
        // #flatten will move everything from $form['expose'][$key] to $form[$key]
        // prior to rendering. That's why the pre_render for it needs to run first,
        // so that when the next pre_render (the one for fieldsets) runs, it gets
        // the flattened data.
        array_unshift($form['#pre_render'], 'views_ui_pre_render_flatten_data');
        $form['expose']['#flatten'] = TRUE;
        $form['expose']['label'] = array(
            '#type' => 'textfield',
            '#default_value' => $this->options['expose']['label'],
            '#title' => t('Label'),
            '#required' => TRUE,
            '#size' => 40,
            '#weight' => -1,
        );
    }
    
    /**
     * Provide default options for exposed sorts.
     */
    public function expose_options() {
        $this->options['expose'] = array(
            'order' => $this->options['order'],
            'label' => $this->definition['title'],
        );
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different
on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered &#039;broken&#039;. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used
a lot.
8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage.
There is no need for this function to actually store the data.
views_handler::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler&#039;s raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.
1
views_handler::has_extra_options public function If a handler has &#039;extra options&#039; it will get a little settings widget and
another form called extra_options.
1
views_handler::init public function Init the handler with necessary data. 6
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is &#039;exposed&#039;, meaning it provides form elements
to let users modify the view.
views_handler::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times.
This is TRUE when exposed filters grouped are using checkboxes as
widgets.
1
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship
it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name public function Return a string representing this handler&#039;s name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_sort::admin_summary public function Display whether or not the sort order is ascending or descending. Overrides views_handler::admin_summary 1
views_handler_sort::can_expose public function Determine if a sort can be exposed. Overrides views_handler::can_expose 1
views_handler_sort::expose_form public function Form for exposed handler options. Overrides views_handler::expose_form
views_handler_sort::expose_options public function Provide default options for exposed sorts. Overrides views_handler::expose_options
views_handler_sort::options_form public function Basic options for all sort criteria. Overrides views_handler::options_form 4
views_handler_sort::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_sort::options_validate public function Simple validate handler. Overrides views_handler::options_validate
views_handler_sort::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition 3
views_handler_sort::query public function Called to add the sort to a query. 10
views_handler_sort::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_sort::show_sort_form public function Shortcut to display the value form. 1
views_handler_sort::sort_options public function Provide a list of options for the default sort form.
views_handler_sort::sort_submit public function
views_handler_sort::sort_validate public function
views_object::$definition public property Handler&#039;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&#039;s option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
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&#039;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