class views_handler_sort_formula

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

Definition items:

  • formula: The formula to use to sort on, such as with a random sort. The formula should be an array, with keys for database types, and 'default' for non-specified. 'default' is required, all others ('mysql', 'mysqli' and 'pgsql' are optional). It is recommended you use 'default' for mysql and create specific overrides for pgsql when the formulae differ.

Hierarchy

Expanded class hierarchy of views_handler_sort_formula

Related topics

Views' sort handlers
Handlers to tell Views how to sort queries

File

handlers/views_handler_sort_formula.inc, line 16

View source 
class views_handler_sort_formula extends views_handler_sort {
    
    /**
     * Constructor to take the formula this sorts on.
     */
    function construct() {
        $this->formula = $this->definition['formula'];
        if (is_array($this->formula) && !isset($this->formula['default'])) {
            $this->error = t('views_handler_sort_formula missing default: @formula', array(
                '@formula' => var_export($this->formula, TRUE),
            ));
        }
        parent::construct();
    }
    
    /**
     * Called to add the sort to a query.
     */
    function query() {
        if (is_array($this->formula)) {
            global $db_type;
            if (isset($this->formula[$db_type])) {
                $formula = $this->formula[$db_type];
            }
            else {
                $formula = $this->formula['default'];
            }
        }
        else {
            $formula = $this->formula;
        }
        $this->ensure_my_table();
        // Add the field.
        $this->query
            ->add_orderby(NULL, $formula, $this->options['order'], $this->table_alias . '_' . $this->field);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
views_handler::$handler_type property The type of the handler, for example filter/footer/field.
views_handler::$query property Where the $query object will reside: 6
views_handler::$view property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access function Check whether current user has access to this handler. 6
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a
a placeholder used when a handler can't be found. 		6
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used
a lot. 		8
views_handler::exposed_info function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_validate function Validate the exposed handler form 4
views_handler::expose_form function Overridable form for exposed handler options.
views_handler::expose_submit 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 function Validate the options form. 1
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options. 1
views_handler::extra_options_submit 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 function Validate the options form.
views_handler::get_field function Shortcut to get a handler's raw field value.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options function If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. 		1
views_handler::init function init the handler with necessary data. 5
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements
to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin. 1
views_handler::pre_query function Run before the view is built. 1
views_handler::sanitize_value function Sanitize the value for output.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship
it needs.
views_handler::show_expose_button function Shortcut to display the expose/hide button.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name function Return a string representing this handler's name in the UI. 10
views_handler::use_group_by function Provides the handler some groupby. 2
views_handler::validate function Validates the handler against the complete View. 1
views_handler_sort::admin_summary function Display whether or not the sort order is ascending or descending Overrides views_handler::admin_summary
views_handler_sort::can_expose function Determine if a sort can be exposed. Overrides views_handler::can_expose
views_handler_sort::exposed_form function Since all exposed sorts are grouped into one select box.
We don't return nothing when views call to exposed_form() 		Overrides views_handler::exposed_form
views_handler_sort::expose_form_left function Handle the 'left' side fo the exposed options form. Overrides views_handler::expose_form_left
views_handler_sort::expose_form_right function Handle the 'right' side fo the exposed options form. Overrides views_handler::expose_form_right
views_handler_sort::expose_options function Provide default options for exposed sorts. Overrides views_handler::expose_options
views_handler_sort::options_form function Basic options for all sort criteria Overrides views_handler::options_form 4
views_handler_sort::options_submit function Simple submit handler Overrides views_handler::options_submit
views_handler_sort::options_validate function Simple validate handler Overrides views_handler::options_validate
views_handler_sort::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition 2
views_handler_sort::show_sort_form function Shortcut to display the value form.
views_handler_sort::sort_options function Provide a list of options for the default sort form.
Should be overridden by classes that don't override sort_form
views_handler_sort::sort_submit function
views_handler_sort::sort_validate function
views_handler_sort_formula::construct function Constructor to take the formula this sorts on. Overrides views_object::construct
views_handler_sort_formula::query function Called to add the sort to a query. Overrides views_handler_sort::query
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::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