class views_handler_sort_date
- 3.x handlers/views_handler_sort_date.inc views_handler_sort_date
- 2.x handlers/views_handler_sort_date.inc views_handler_sort_date
Basic sort handler for dates.
This handler enables granularity, which is the ability to make dates equivalent based upon nearness.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_sort
- class \views_handler_sort_date
- class \views_handler_sort
- class \views_handler
Expanded class hierarchy of views_handler_sort_date
Related topics
8 string references to 'views_handler_sort_date'
- aggregator_views_data in modules/
aggregator.views.inc - Implements hook_views_data().
- comment_views_data in modules/
comment.views.inc - hook_views_data in ./
views.api.php - Describes data tables (or the equivalent) to Views.
- node_views_data in modules/
node.views.inc - Implements hook_views_data().
- system_views_data in modules/
system.views.inc - Implements hook_views_data().
File
- handlers/
views_handler_sort_date.inc, line 16 - Definition of views_handler_sort_date.
View source
class views_handler_sort_date extends views_handler_sort {
function option_definition() {
$options = parent::option_definition();
$options['granularity'] = array('default' => 'second');
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['granularity'] = array(
'#type' => 'radios',
'#title' => t('Granularity'),
'#options' => array(
'second' => t('Second'),
'minute' => t('Minute'),
'hour' => t('Hour'),
'day' => t('Day'),
'month' => t('Month'),
'year' => t('Year'),
),
'#description' => t('The granularity is the smallest unit to use when determining whether two dates are the same; for example, if the granularity is "Year" then all dates in 1999, regardless of when they fall in 1999, will be considered the same date.'),
'#default_value' => $this->options['granularity'],
);
}
/**
* Called to add the sort to a query.
*/
function query() {
$this->ensure_my_table();
switch ($this->options['granularity']) {
case 'second':
default:
$this->query->add_orderby($this->table_alias, $this->real_field, $this->options['order']);
return;
case 'minute':
$formula = views_date_sql_format('YmdHi', "$this->table_alias.$this->real_field");
break;
case 'hour':
$formula = views_date_sql_format('YmdH', "$this->table_alias.$this->real_field");
break;
case 'day':
$formula = views_date_sql_format('Ymd', "$this->table_alias.$this->real_field");
break;
case 'month':
$formula = views_date_sql_format('Ym', "$this->table_alias.$this->real_field");
break;
case 'year':
$formula = views_date_sql_format('Y', "$this->table_alias.$this->real_field");
break;
}
// Add the field.
$this->query->add_orderby(NULL, $formula, $this->options['order'], $this->table_alias . '_' . $this->field . '_' . $this->options['granularity']);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Take input from exposed handlers 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 | Transform a string by a certain method. | |
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 handler form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
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:: |
function | Validate the options form. | |
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 | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
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 | 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 | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
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:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
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 | Provides the handler some groupby. | |
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 |
Determine if a sort can be exposed. Overrides views_handler:: |
|
views_handler_sort:: |
function |
Form for exposed handler options. Overrides views_handler:: |
|
views_handler_sort:: |
function |
Provide default options for exposed sorts. Overrides views_handler:: |
|
views_handler_sort:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_sort:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler_sort:: |
function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_sort:: |
function | Shortcut to display the value form. | |
views_handler_sort:: |
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:: |
function | ||
views_handler_sort:: |
function | ||
views_handler_sort_date:: |
function |
Basic options for all sort criteria Overrides views_handler_sort:: |
|
views_handler_sort_date:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_sort:: |
|
views_handler_sort_date:: |
function |
Called to add the sort to a query. Overrides views_handler_sort:: |
|
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 | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
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 | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function |