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
Related topics
9 string references to 'views_handler_filter_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().
- statistics_views_data in modules/
statistics.views.inc - Implements hook_views_data().
File
- handlers/
views_handler_filter_date.inc, line 13 - Definition of views_handler_filter_date.
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']['contains']['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($this->options['exposed']) && empty($form_state['values']['options']['expose']['required'])) {
// Who cares what the value is if it's exposed and non-required.
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']['required'])) {
// Who cares what the value is if it's exposed and non-required.
return;
}
$value = &$form_state['values'][$this->options['expose']['identifier']];
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id'])) {
$operator = $form_state['values'][$this->options['expose']['operator_id']];
}
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.'));
}
}
}
/**
* Validate the build group options form.
*/
function build_group_validate($form, &$form_state) {
// Special case to validate grouped date filters, this is because the
// $group['value'] array contains the type of filter (date or offset)
// and therefore the number of items the comparission has to be done
// against 'one' instead of 'zero'.
foreach ($form_state['values']['options']['group_info']['group_items'] as $id => $group) {
if (empty($group['remove'])) {
// Check if the title is defined but value wasn't defined.
if (!empty($group['title'])) {
if ((!is_array($group['value']) && empty($group['value'])) || (is_array($group['value']) && count(array_filter($group['value'])) == 1)) {
form_error($form['group_info']['group_items'][$id]['value'], t('The value is required if title for this item is defined.'));
}
}
// Check if the value is defined but title wasn't defined.
if ((!is_array($group['value']) && !empty($group['value'])) || (is_array($group['value']) && count(array_filter($group['value'])) > 1)) {
if (empty($group['title'])) {
form_error($form['group_info']['group_items'][$id]['title'], t('The title is required if value for this item is defined.'));
}
}
}
}
}
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_id'])) {
$operator = $input[$this->options['expose']['operator_id']];
}
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) {
$a = intval(strtotime($this->value['min'], 0));
$b = intval(strtotime($this->value['max'], 0));
if ($this->value['type'] == 'offset') {
$a = '***CURRENT_TIME***' . sprintf('%+d', $a); // keep sign
$b = '***CURRENT_TIME***' . sprintf('%+d', $b); // keep sign
}
// This is safe because we are manually scrubbing the values.
// It is necessary to do it this way because $a and $b are formulas when using an offset.
$operator = strtoupper($this->operator);
$this->query->add_where_expression($this->options['group'], "$field $operator $a AND $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 is safe because we are manually scrubbing the value.
// It is necessary to do it this way because $value is a formula when using an offset.
$this->query->add_where_expression($this->options['group'], "$field $this->operator $value");
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler_filter_date:: |
function |
Overrides views_handler_filter_numeric:: |
|
views_handler_filter_date:: |
function |
Overrides views_handler_filter_numeric:: |
|
views_handler_filter_numeric:: |
function | ||
views_handler_filter_numeric:: |
function | ||
views_handler_filter_numeric:: |
function | ||
views_handler_filter_numeric:: |
function | ||
views_handler_filter:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_handler_filter_date:: |
function |
Add a type selector to the value form Overrides views_handler_filter_numeric:: |
|
views_handler_filter_numeric:: |
function |
Add this filter to the query. Overrides views_handler_filter:: |
|
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_handler_filter:: |
function | Build a form containing a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler_filter:: |
function | Can this filter be used in OR groups? | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler_filter:: |
function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler:: |
function | Determine if the argument needs a style plugin. | |
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 this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler_filter_numeric:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter:: |
|
views_handler_filter_date:: |
function |
Do some minor translation of the exposed input Overrides views_handler_filter_numeric:: |
|
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
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_filter:: |
function | If set to remember exposed input in the session, store it there. This function is similar to store_exposed_input but modified to work properly when the filter is a group. | |
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter_date:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_filter_numeric:: |
|
views_object:: |
function | Let the handler know what its full definition is. | |
views_handler_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function |
Options form subform for exposed filter options. Overrides views_handler:: |
|
views_handler_filter:: |
function | Options form subform for setting the operator. | |
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_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 | 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 | 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 | 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 | Provide a form for aggregation settings. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler_filter_numeric:: |
function |
Provide a list of all the numeric operators Overrides views_handler_filter:: |
|
views_handler_filter:: |
function |
Provide default options for exposed filters. Overrides views_handler:: |
|
views_handler_filter:: |
function | Provide default options for exposed filters. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler_filter:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
|
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:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler_filter:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler:: |
|
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler_filter:: |
function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
views_handler_filter:: |
function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides views_handler:: |
|
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_filter:: |
function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | |
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_handler_filter:: |
function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
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:: |
function | Shortcut to get a handler's raw field value. | |
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter_date:: |
function |
Simple validate handler Overrides views_handler_filter:: |
|
views_handler:: |
function | Submit the exposed handler form | |
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:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Transform a string by a certain method. | |
views_object:: |
function | Unpack a single option definition. | |
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 | Unpacks each handler to store translatable texts. | |
views_handler_filter_date:: |
function | Validate that the time values convert to something usable. | |
views_handler_filter_date:: |
function |
Validate the build group options form. Overrides views_handler_filter:: |
|
views_handler_filter_date:: |
function |
Validate the exposed handler form Overrides views_handler:: |
|
views_handler_filter:: |
function | Validate the operator form. | |
views_handler_filter:: |
function | Validate the options form. | |
views_handler_filter:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. |