class views_handler_sort
- 3.x handlers/views_handler_sort.inc views_handler_sort
- 2.x handlers/views_handler_sort.inc views_handler_sort
Base sort handler that has no options and performs a simple sort
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_sort
- class \views_handler
Expanded class hierarchy of views_handler_sort
Related topics
18 string references to 'views_handler_sort'
- aggregator_views_data in modules/
aggregator.views.inc - Implementation of hook_views_data()
- book_views_data in modules/
book.views.inc - Implementation of hook_views_data()
- comment_views_data in modules/
comment.views.inc - comment_views_data_alter in modules/
comment.views.inc - Use views_data_alter to add items to the node table that are relevant to comments.
- comment_views_handlers in modules/
comment.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
File
- handlers/
views_handler_sort.inc, line 11
View source
class views_handler_sort extends views_handler {
/**
* Called to add the sort to a query.
*/
function query() {
$this->ensure_my_table();
// Add the field.
$this->query->add_orderby($this->table_alias, $this->real_field, $this->options['order']);
}
function option_definition() {
$options = parent::option_definition();
$options['order'] = array('default' => 'ASC');
return $options;
}
/**
* Display whether or not the sort order is ascending or descending
*/
function admin_summary() {
switch ($this->options['order']) {
case 'ASC':
case 'asc':
default:
$type = t('asc');
break;
case 'DESC':
case 'desc':
$type = t('desc');
break;
}
return '<span class="views-ascending"><span>' . $type . '</span></span>';
}
/**
* Basic options for all sort criteria
*/
function options_form(&$form, &$form_state) {
$form['order'] = array(
'#type' => 'radios',
'#title' => t('Sort order'),
'#options' => array('ASC' => t('Ascending'), 'DESC' => t('Descending')),
'#default_value' => $this->options['order'],
);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
function | Take input from exposed filters and assign to this handler, if necessary. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_handler:: |
function | Determine if a handler can be exposed. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Render our chunk of the exposed filter form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed filter form | |
views_handler:: |
function | Validate the exposed filter form | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler:: |
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:: |
function | Validate the options form. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | init the handler with necessary data. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
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:: |
function | Validate the options form. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_sort:: |
function |
Display whether or not the sort order is ascending or descending Overrides views_handler:: |
|
views_handler_sort:: |
function |
Basic options for all sort criteria Overrides views_handler:: |
|
views_handler_sort:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_object:: |
|
views_handler_sort:: |
function |
Called to add the sort to a query. Overrides views_handler:: |
|
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | ||
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
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:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function |