You are here

Home » API reference » Views (for Drupal 7) 7.3 » views_handler_sort_date.inc

class views_handler_sort_date in Views (for Drupal 7) 7.3

Same name and namespace in other branches
  1. 6.3 handlers/views_handler_sort_date.inc \views_handler_sort_date
  2. 6.2 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

Expanded class hierarchy of views_handler_sort_date

Related topics

Views sort handlers
Handlers to tell Views how to sort queries.
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
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().
system_views_data in modules/system.views.inc
Implements hook_views_data().

... See full list

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 {

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['granularity'] = array(
      'default' => 'second',
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public 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'],
    );
  }

  /**
   * {@inheritdoc}
   */
  public 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

Namesort descending Modifiers Type Description 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::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
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_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
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::expose_validate public function Validate the options form. 1
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::init public function Init the handler with necessary data. 6
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 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::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
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::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
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_sort::admin_summary public function Display whether or not the sort order is ascending or descending Overrides views_handler::admin_summary 1
views_handler_sort::can_expose public function Determine if a sort can be exposed. Overrides views_handler::can_expose 1
views_handler_sort::expose_form public function Form for exposed handler options. Overrides views_handler::expose_form
views_handler_sort::expose_options public function Provide default options for exposed sorts. Overrides views_handler::expose_options
views_handler_sort::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_sort::options_validate public function Simple validate handler. Overrides views_handler::options_validate
views_handler_sort::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_sort::show_sort_form public function Shortcut to display the value form. 1
views_handler_sort::sort_options public function Provide a list of options for the default sort form.
views_handler_sort::sort_submit public function
views_handler_sort::sort_validate public function
views_handler_sort_date::options_form public function Basic options for all sort criteria Overrides views_handler_sort::options_form
views_handler_sort_date::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_sort::option_definition
views_handler_sort_date::query public function Called to add the sort to a query. Overrides views_handler_sort::query 1
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 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