class views_handler_filter_date
- 3.x handlers/views_handler_filter_date.inc views_handler_filter_date
- 2.x handlers/views_handler_filter_date.inc views_handler_filter_date
Filter to handle dates stored as a timestamp.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_filter
- class \views_handler_filter_numeric
- class \views_handler_filter_date
- class \views_handler_filter_numeric
- class \views_handler_filter
- class \views_handler
Expanded class hierarchy of views_handler_filter_date
9 string references to 'views_handler_filter_date'
- aggregator_views_data in modules/
aggregator.views.inc - Implementation of hook_views_data()
- comment_views_data in modules/
comment.views.inc - comment_views_handlers in modules/
comment.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
- hook_views_data in docs/
docs.php - Describe table structure to Views.
- node_views_data in modules/
node.views.inc - Implementation of hook_views_data()
File
- handlers/
views_handler_filter_date.inc, line 6
View source
class views_handler_filter_date extends views_handler_filter_numeric {
function option_definition() {
$options = parent::option_definition();
// value is already set up properly, we're just adding our new field to it.
$options['value']['type']['default'] = 'date';
return $options;
}
/**
* Add a type selector to the value form
*/
function value_form(&$form, &$form_state) {
if (empty($form_state['exposed'])) {
$form['value']['type'] = array(
'#type' => 'radios',
'#title' => t('Value type'),
'#options' => array(
'date' => t('A date in any machine readable format. CCYY-MM-DD HH:MM:SS is preferred.'),
'offset' => t('An offset from the current time such as "!example1" or "!example2"', array('!example1' => '+1 day', '!example2' => '-2 hours -30 minutes')),
),
'#default_value' => !empty($this->value['type']) ? $this->value['type'] : 'date',
);
}
parent::value_form($form, $form_state);
}
function options_validate(&$form, &$form_state) {
parent::options_validate($form, $form_state);
if (!empty($form_state['values']['options']['expose']['optional'])) {
// Who cares what the value is if it's exposed and optional.
return;
}
$this->validate_valid_time($form['value'], $form_state['values']['options']['operator'], $form_state['values']['options']['value']);
}
function exposed_validate(&$form, &$form_state) {
if (empty($this->options['exposed'])) {
return;
}
if (!empty($this->options['expose']['optional'])) {
// Who cares what the value is if it's exposed and optional.
return;
}
$value = &$form_state['values'][$this->options['expose']['identifier']];
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator'])) {
$operator = $form_state['values'][$this->options['expose']['operator']];
}
else {
$operator = $this->operator;
}
$this->validate_valid_time($this->options['expose']['identifier'], $operator, $value);
}
/**
* Validate that the time values convert to something usable.
*/
function validate_valid_time(&$form, $operator, $value) {
$operators = $this->operators();
if ($operators[$operator]['values'] == 1) {
$convert = strtotime($value['value']);
if (!empty($form['value']) && ($convert == -1 || $convert === FALSE)) {
form_error($form['value'], t('Invalid date format.'));
}
}
elseif ($operators[$operator]['values'] == 2) {
$min = strtotime($value['min']);
if ($min == -1 || $min === FALSE) {
form_error($form['min'], t('Invalid date format.'));
}
$max = strtotime($value['max']);
if ($max == -1 || $max === FALSE) {
form_error($form['max'], t('Invalid date format.'));
}
}
}
function accept_exposed_input($input) {
if (empty($this->options['exposed'])) {
return TRUE;
}
// Store this because it will get overwritten.
$type = $this->value['type'];
$rc = parent::accept_exposed_input($input);
// Don't filter if value(s) are empty.
$operators = $this->operators();
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator'])) {
$operator = $input[$this->options['expose']['operator']];
}
else {
$operator = $this->operator;
}
if ($operators[$operator]['values'] == 1) {
if ($this->value['value'] == '') {
return FALSE;
}
}
else {
if ($this->value['min'] == '' || $this->value['max'] == '') {
return FALSE;
}
}
// restore what got overwritten by the parent.
$this->value['type'] = $type;
return $rc;
}
function op_between($field) {
if ($this->operator == 'between') {
$a = intval(strtotime($this->value['min'], 0));
$b = intval(strtotime($this->value['max'], 0));
}
else {
$a = intval(strtotime($this->value['max'], 0));
$b = intval(strtotime($this->value['min'], 0));
}
if ($this->value['type'] == 'offset') {
$a = '***CURRENT_TIME***' . sprintf('%+d', $a); // keep sign
$b = '***CURRENT_TIME***' . sprintf('%+d', $b); // keep sign
}
// %s is safe here because strtotime scrubbed the input and we might
// have a string if using offset.
if ($this->operator == 'between') {
$this->query->add_where($this->options['group'], "$field >= %s", $a);
$this->query->add_where($this->options['group'], "$field <= %s", $b);
}
else {
$this->query->add_where($this->options['group'], "$field >= %s OR $field <= %s", array($a, $b));
}
}
function op_simple($field) {
$value = intval(strtotime($this->value['value'], 0));
if (!empty($this->value['type']) && $this->value['type'] == 'offset') {
$value = '***CURRENT_TIME***' . sprintf('%+d', $value); // keep sign
}
$this->query->add_where($this->options['group'], "$field $this->operator %s", $value);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
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 | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Submit the exposed filter 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 | 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 | 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 | 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 | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler:: |
|
views_handler_filter:: |
function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides views_handler:: |
|
views_handler_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function | Overridable form for exposed filter options. | |
views_handler_filter:: |
function | Handle the 'left' side fo the exposed options form. | |
views_handler_filter:: |
function | Handle the 'right' side fo the exposed options form. | |
views_handler_filter:: |
function |
Provide default options for exposed filters. Overrides views_handler:: |
|
views_handler_filter:: |
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_filter:: |
function | Validate the options form. | |
views_handler_filter:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
|
views_handler_filter:: |
function | Provide a form for setting the operator. | |
views_handler_filter:: |
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_filter:: |
function | Validate the operator form. | |
views_handler_filter:: |
function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the expose/hide button. | |
views_handler_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
function | Shortcut to display the operator form. | |
views_handler_filter:: |
function | Shortcut to display the value form. | |
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter:: |
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_filter:: |
function | Validate the options form. | |
views_handler_filter_date:: |
function |
Do some minor translation of the exposed input Overrides views_handler_filter_numeric:: |
|
views_handler_filter_date:: |
function |
Validate the exposed filter form Overrides views_handler:: |
|
views_handler_filter_date:: |
function |
Simple validate handler Overrides views_handler_filter:: |
|
views_handler_filter_date:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_numeric:: |
|
views_handler_filter_date:: |
function |
Overrides views_handler_filter_numeric:: |
|
views_handler_filter_date:: |
function |
Overrides views_handler_filter_numeric:: |
|
views_handler_filter_date:: |
function | Validate that the time values convert to something usable. | |
views_handler_filter_date:: |
function |
Add a type selector to the value form Overrides views_handler_filter_numeric:: |
|
views_handler_filter_numeric:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter:: |
|
views_handler_filter_numeric:: |
function | ||
views_handler_filter_numeric:: |
function |
Provide a list of all the numeric operators Overrides views_handler_filter:: |
|
views_handler_filter_numeric:: |
function | ||
views_handler_filter_numeric:: |
function | ||
views_handler_filter_numeric:: |
function |
Add this filter to the query. Overrides views_handler_filter:: |
|
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 |