Full ELMS Learning Network documentation
class views_handler_sort
×
Error message
User warning: The following module is missing from the file system: theme/theme. For information about how to fix this, see the documentation page. in _drupal_trigger_error_with_delayed_logging() (line 1156 of /var/www/html/elmsln_community/api.elmsln.org/includes/bootstrap.inc).- cis7 sites/all/modules/ulmus/views/handlers/views_handler_sort.inc views_handler_sort
- cle7 sites/all/modules/ulmus/views/handlers/views_handler_sort.inc views_handler_sort
- elmsmedia7 sites/all/modules/ulmus/views/handlers/views_handler_sort.inc views_handler_sort
- icor7 sites/all/modules/ulmus/views/handlers/views_handler_sort.inc views_handler_sort
- meedjum_blog7 sites/all/modules/ulmus/views/handlers/views_handler_sort.inc views_handler_sort
- mooc7 sites/all/modules/ulmus/views/handlers/views_handler_sort.inc views_handler_sort
Base sort handler that has no options and performs a simple sort.
Hierarchy
- class views_handler_sort
Expanded class hierarchy of views_handler_sort
Members
Name![]() |
Modifiers | Type | Description |
---|---|---|---|
views_handler::$table_alias | public | property | The alias of the table of this handler which is used in the query. |
views_handler::accept_exposed_input | function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler::access | function | Check whether current user has access to this handler. | |
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. | |
views_handler::case_transform | function | Transform a string by a certain method. | |
views_handler::ensure_my_table | function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler::exposed_form | function | Render our chunk of the exposed handler form when selecting | |
views_handler::exposed_info | function | Get information about the exposed form for the form renderer. | |
views_handler::exposed_submit | function | Submit the exposed handler form | |
views_handler::exposed_validate | function | Validate the exposed handler form | |
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. | |
views_handler::extra_options | function | Provide defaults for the handler. | |
views_handler::extra_options_form | function | Provide a form for setting options. | |
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::groupby_form | function | Provide a form for aggregation settings. | |
views_handler::groupby_form_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::has_extra_options | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler::init | function | init the handler with necessary data. | |
views_handler::is_a_group | function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler::is_exposed | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler::multiple_exposed_input | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
views_handler::needs_style_plugin | function | Determine if the argument needs a style plugin. | |
views_handler::placeholder | function | Provides a unique placeholders for handlers. | |
views_handler::post_execute | function | Run after the view is executed, before the result is cached. | |
views_handler::pre_query | function | Run before the view is built. | |
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_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. | |
views_handler::ui_name | function | Return a string representing this handler's name in the UI. | |
views_handler::use_group_by | function | Provides the handler some groupby. | |
views_handler::validate | function | Validates the handler against the complete View. | |
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::expose_form | function | Form for exposed handler options. Overrides views_handler::expose_form | |
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 | |
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. @code 'option_name' => array( Overrides views_handler::option_definition | |
views_handler_sort::query | function | Called to add the sort to a query. | |
views_handler_sort::show_expose_button | function | Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button | |
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_object::construct | function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object::destroy | function | ||
views_object::export_option | function | ||
views_object::export_options | function | ||
views_object::export_option_always | function | Always exports the option, regardless of the default value. | |
views_object::options Deprecated | function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
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 |
File
- sites/
all/ modules/ ulmus/ views/ handlers/ views_handler_sort.inc, line 19 - @todo.
View source
class views_handler_sort extends views_handler {
/**
* Determine if a sort can be exposed.
*/
function can_expose() {
return TRUE;
}
/**
* 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');
$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
*/
function admin_summary() {
if (!empty($this->options['exposed'])) {
return t('Exposed');
}
switch ($this->options['order']) {
case 'ASC':
case 'asc':
default:
return t('asc');
break;
case 'DESC':
case 'desc':
return t('desc');
break;
}
}
/**
* Basic options for all sort criteria
*/
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.
*/
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
*/
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
*/
function options_submit(&$form, &$form_state) {
unset($form_state['values']['expose_button']); // don't store this.
$this->sort_submit($form, $form_state);
if (!empty($this->options['exposed'])) {
$this->expose_submit($form, $form_state);
}
}
/**
* Shortcut to display the value form.
*/
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'],
);
}
}
function sort_validate(&$form, &$form_state) {
}
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
*/
function sort_options() {
return array(
'ASC' => t('Sort ascending'),
'DESC' => t('Sort descending'),
);
}
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.
*/
function expose_options() {
$this->options['expose'] = array(
'order' => $this->options['order'],
'label' => $this->definition['title'],
);
}
}
Related topics
30 string references to 'views_handler_sort'
- accessibility_reporting_views_data in sites/
all/ modules/ ulmus/ accessibility/ modules/ accessibility_reporting/ views/ accessibility_reporting.views.inc - Implements hook_views_data().
- accessibility_views_data in sites/
all/ modules/ ulmus/ accessibility/ views/ accessibility.views.inc - @file Providing extra functionality for views.
- aggregator_views_data in sites/
all/ modules/ ulmus/ views/ modules/ aggregator.views.inc - Implements hook_views_data().
- book_views_data in sites/
all/ modules/ ulmus/ views/ modules/ book.views.inc - Implements hook_views_data().
- comment_views_data in sites/
all/ modules/ ulmus/ views/ modules/ comment.views.inc