class views_handler_filter_date
Filter to handle dates stored as a timestamp.
Hierarchy
- class \views_object
- class \views_handler extends \views_object
- class \views_handler_filter extends \views_handler
- class \views_handler_filter_numeric extends \views_handler_filter
- class \views_handler_filter_date extends \views_handler_filter_numeric
- class \views_handler_filter_numeric extends \views_handler_filter
- class \views_handler_filter extends \views_handler
- class \views_handler extends \views_object
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 - Implements hook_views_data().
- 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
View source
class views_handler_filter_date extends views_handler_filter_numeric {
/**
* {@inheritdoc}
*/
public 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.
*/
public 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);
}
/**
* {@inheritdoc}
*/
public 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']);
}
/**
* {@inheritdoc}
*/
public 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.
*/
public 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.
*/
public 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.'));
}
}
}
}
}
/**
* {@inheritdoc}
*/
public function accept_exposed_input($input) {
if (empty($this->options['exposed'])) {
return TRUE;
}
// Store this because it will get overwritten.
$type = '';
if (is_array($this->value)) {
$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;
}
}
elseif ($operators[$operator]['values'] == 2) {
if ($this->value['min'] == '' || $this->value['max'] == '') {
return FALSE;
}
}
// Restore what got overwritten by the parent.
if (is_array($this->value)) {
$this->value['type'] = $type;
}
return $rc;
}
/**
*
*/
public function op_between($field) {
// Use the substitutions to ensure a consistent timestamp.
$query_substitutions = views_views_query_substitutions($this->view);
$a = intval(strtotime($this->value['min'], $query_substitutions['***CURRENT_TIME***']));
$b = intval(strtotime($this->value['max'], $query_substitutions['***CURRENT_TIME***']));
// 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}");
}
/**
*
*/
public function op_simple($field) {
// Use the substitutions to ensure a consistent timestamp.
$query_substitutions = views_views_query_substitutions($this->view);
$value = intval(strtotime($this->value['value'], $query_substitutions['***CURRENT_TIME***']));
// 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
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
views_handler::$handler_type | public | property | The type of the handler, for example filter/footer/field. | |||
views_handler::$query | public | property | Where the $query object will reside:. | 1 | ||
views_handler::$real_field | public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. |
|||
views_handler::$relationship | public | property | The relationship used for this field. | |||
views_handler::$table_alias | public | property | The alias of the table of this handler which is used in the query. | |||
views_handler::$view | public | property | The top object of a view. | Overrides views_object::$view | ||
views_handler::access | public | function | Check whether current user has access to this handler. | 10 | ||
views_handler::broken | public | function | Determine if the handler is considered 'broken'. | 6 | ||
views_handler::case_transform | public | function | Transform a string by a certain method. | |||
views_handler::ensure_my_table | public | function | Ensure the main table for this handler is in the query. This is used a lot. |
8 | ||
views_handler::exposed_submit | public | function | Submit the exposed handler form. | |||
views_handler::expose_submit | public | 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::extra_options | public | function | Provide defaults for the handler. | |||
views_handler::extra_options_form | public | function | Provide a form for setting options. | 1 | ||
views_handler::extra_options_submit | public | 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 | public | function | Validate the options form. | |||
views_handler::get_field | public | function | Shortcut to get a handler's raw field value. | |||
views_handler::get_join | public | function | Get the join object that should be used for this handler. | |||
views_handler::groupby_form | public | function | Provide a form for aggregation settings. | 1 | ||
views_handler::groupby_form_submit | public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. |
1 | ||
views_handler::has_extra_options | public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. |
1 | ||
views_handler::is_exposed | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. |
|||
views_handler::needs_style_plugin | public | function | Determine if the argument needs a style plugin. | 1 | ||
views_handler::placeholder | public | function | Provides a unique placeholders for handlers. | |||
views_handler::post_execute | public | function | Run after the view is executed, before the result is cached. | 1 | ||
views_handler::pre_query | public | function | Run before the view is built. | 1 | ||
views_handler::sanitize_value | public | function | Sanitize the value for output. | |||
views_handler::set_relationship | public | function | Called just prior to query(), this lets a handler set up any relationship it needs. |
|||
views_handler::show_expose_form | public | function | Shortcut to display the exposed options form. | |||
views_handler::ui_name | public | function | Return a string representing this handler's name in the UI. | 9 | ||
views_handler::use_group_by | public | function | Provides the handler some groupby. | 2 | ||
views_handler::validate | public | function | Validates the handler against the complete View. | 1 | ||
views_handler_filter::$always_required | public | property | Disable the possibility to allow a exposed input to be optional. | |||
views_handler_filter::$group_info | public | property | Contains the information of the selected item in a gruped filter. | |||
views_handler_filter::$no_operator | public | property | Disable the possibility to use operators. | 2 | ||
views_handler_filter::$operator | public | property | Contains the operator which is used on the query. | |||
views_handler_filter::$value | public | property | Contains the actual value of the field. | |||
views_handler_filter::build_group_form | public | function | Build the form to let users create the group of exposed filters. | |||
views_handler_filter::build_group_options | public | function | Provide default options for exposed filters. | |||
views_handler_filter::build_group_submit | public | function | Save new group items, re-enumerates and remove groups marked to delete. | |||
views_handler_filter::can_build_group | public | function | Determine if a filter can be converted into a group. | |||
views_handler_filter::can_expose | public | function | Determine if a filter can be exposed. | Overrides views_handler::can_expose | 5 | |
views_handler_filter::can_group | public | function | Can this filter be used in OR groups? | 1 | ||
views_handler_filter::convert_exposed_input | public | function | Transform the input from a grouped filter into a standard filter. | |||
views_handler_filter::exposed_form | public | function | Render our chunk of the exposed filter form when selecting. | Overrides views_handler::exposed_form | ||
views_handler_filter::exposed_info | public | function | Tell the renderer about our exposed form. | Overrides views_handler::exposed_info | ||
views_handler_filter::exposed_translate | public | function | Make some translations to a form item to make it more suitable to exposing. | |||
views_handler_filter::expose_form | public | function | Options form subform for exposed filter options. | Overrides views_handler::expose_form | 2 | |
views_handler_filter::expose_options | public | function | Provide default options for exposed filters. | Overrides views_handler::expose_options | 2 | |
views_handler_filter::expose_validate | public | function | Validate the options form. | Overrides views_handler::expose_validate | ||
views_handler_filter::group_form | public | function | Build a form with a group of operator | values to apply as a single filter. | |||
views_handler_filter::group_multiple_exposed_input | public | function | Options available for a grouped filter which uses checkboxes. | |||
views_handler_filter::init | public | function | Provide some extra help to get the operator/value easier to use. | Overrides views_handler::init | 2 | |
views_handler_filter::is_a_group | public | function | Returns TRUE if the exposed filter works like a grouped filter. | Overrides views_handler::is_a_group | ||
views_handler_filter::multiple_exposed_input | public | function | Indicate whether users can select multiple group items. | Overrides views_handler::multiple_exposed_input | ||
views_handler_filter::operator_form | public | function | Options form subform for setting the operator. | 6 | ||
views_handler_filter::operator_submit | public | function | Perform any necessary changes to the form values prior to storage. | |||
views_handler_filter::operator_validate | public | function | Validate the operator form. | |||
views_handler_filter::options_form | public | function | Provide the basic form which calls through to subforms. | Overrides views_handler::options_form | 4 | |
views_handler_filter::options_submit | public | function | Simple submit handler. | Overrides views_handler::options_submit | ||
views_handler_filter::prepare_filter_select_options | public | function | Sanitizes the HTML select element's options. | |||
views_handler_filter::show_build_group_button | public | function | Shortcut to display the build_group/hide button. | |||
views_handler_filter::show_build_group_form | public | function | Shortcut to display the exposed options form. | |||
views_handler_filter::show_expose_button | public | function | Shortcut to display the expose/hide button. | Overrides views_handler::show_expose_button | ||
views_handler_filter::show_operator_form | public | function | Shortcut to display the operator form. | |||
views_handler_filter::show_value_form | public | function | Shortcut to display the value form. | |||
views_handler_filter::store_exposed_input | public | function | Store the exposed input for processing later. | Overrides views_handler::store_exposed_input | ||
views_handler_filter::store_group_input | public | function | If set to remember exposed input in the session, store it there. | |||
views_handler_filter::value_submit | public | function | Perform any necessary changes to the form values prior to storage. | 1 | ||
views_handler_filter::value_validate | public | function | Validate the options form. | 3 | ||
views_handler_filter_date::accept_exposed_input | public | function | Do some minor translation of the exposed input. | Overrides views_handler_filter_numeric::accept_exposed_input | ||
views_handler_filter_date::build_group_validate | public | function | Validate the build group options form. | Overrides views_handler_filter::build_group_validate | ||
views_handler_filter_date::exposed_validate | public | function | Validate the exposed handler form. | Overrides views_handler::exposed_validate | ||
views_handler_filter_date::options_validate | public | function | Simple validate handler. | Overrides views_handler_filter::options_validate | ||
views_handler_filter_date::option_definition | public | function | Information about options for all kinds of purposes will be held here. | Overrides views_handler_filter_numeric::option_definition | ||
views_handler_filter_date::op_between | public | function | Overrides views_handler_filter_numeric::op_between | |||
views_handler_filter_date::op_simple | public | function | Overrides views_handler_filter_numeric::op_simple | |||
views_handler_filter_date::validate_valid_time | public | function | Validate that the time values convert to something usable. | |||
views_handler_filter_date::value_form | public | function | Add a type selector to the value form. | Overrides views_handler_filter_numeric::value_form | ||
views_handler_filter_numeric::$always_multiple | public | property | Exposed filter options. | Overrides views_handler_filter::$always_multiple | ||
views_handler_filter_numeric::admin_summary | public | function | Display the filter on the administrative summary. | Overrides views_handler_filter::admin_summary | ||
views_handler_filter_numeric::operators | public | function | ||||
views_handler_filter_numeric::operator_options | public | function | Provide a list of all the numeric operators. | Overrides views_handler_filter::operator_options | ||
views_handler_filter_numeric::operator_values | public | function | ||||
views_handler_filter_numeric::op_empty | public | function | 2 | |||
views_handler_filter_numeric::op_not_regex | public | function | ||||
views_handler_filter_numeric::op_regex | public | function | 1 | |||
views_handler_filter_numeric::query | public | function | Add this filter to the query. | Overrides views_handler_filter::query | 2 | |
views_object::$definition | public | property | Handler's definition. | |||
views_object::$options | public | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::altered_option_definition | public | function | Collect this handler's option definition and alter them, ready for use. | |||
views_object::construct | public | function | Views handlers use a special construct function. | 4 | ||
views_object::destroy | public | function | Destructor. | 2 | ||
views_object::export_option | public | function | 1 | |||
views_object::export_options | public | function | ||||
views_object::export_option_always | public | function | Always exports the option, regardless of the default value. | |||
views_object::options | Deprecated | public | function | Set default options on this object. | 1 | |
views_object::set_default_options | public | function | Set default options. | |||
views_object::set_definition | public | function | Let the handler know what its full definition is. | |||
views_object::unpack_options | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
|||
views_object::unpack_translatable | public | function | Unpack a single option definition. | |||
views_object::unpack_translatables | public | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | public | function |