class views_handler_field_date
A handler to provide proper displays for dates.
This may be used on table fields that hold either UNIX timestamps or SQL datetime strings.
Hierarchy
- class \views_object- class \views_handler extends \views_object- class \views_handler_field extends \views_handler- class \views_handler_field_date extends \views_handler_field
 
 
- class \views_handler_field extends \views_handler
 
- class \views_handler extends \views_object
Expanded class hierarchy of views_handler_field_date
Related topics
10 string references to 'views_handler_field_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_field_date.inc, line 16 
View source
class views_handler_field_date extends views_handler_field {
  
  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['date_format'] = array(
      'default' => 'small',
    );
    $options['custom_date_format'] = array(
      'default' => '',
    );
    $options['second_date_format_custom'] = array(
      'default' => '',
    );
    $options['second_date_format'] = array(
      'default' => 'small',
    );
    $options['timezone'] = array(
      'default' => '',
    );
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    $date_formats = array();
    $date_types = system_get_date_types();
    foreach ($date_types as $value) {
      $date_formats[$value['type']] = t('@date_format format', array(
        '@date_format' => $value['title'],
      )) . ': ' . format_date(REQUEST_TIME, $value['type']);
    }
    $form['date_format'] = array(
      '#type' => 'select',
      '#title' => t('Date format'),
      '#options' => $date_formats + array(
        'custom' => t('Custom'),
        'raw time ago' => t('Time ago'),
        'time ago' => t('Time ago (with "ago" appended)'),
        'today time ago' => t('Time ago (with "ago" appended) for today\'s date, but not for other dates'),
        'raw time hence' => t('Time hence'),
        'time hence' => t('Time hence (with "hence" appended)'),
        'raw time span' => t('Time span (future dates have "-" prepended)'),
        'inverse time span' => t('Time span (past dates have "-" prepended)'),
        'time span' => t('Time span (with "ago/hence" appended)'),
      ),
      '#default_value' => isset($this->options['date_format']) ? $this->options['date_format'] : 'small',
    );
    $form['custom_date_format'] = array(
      '#type' => 'textfield',
      '#title' => t('Custom date format'),
      '#description' => t('If "Custom", see the <a href="@url" target="_blank">PHP manual</a> for date formats. Otherwise, enter the number of different time units to display, which defaults to 2.', array(
        '@url' => 'http://php.net/manual/function.date.php',
      )),
      '#default_value' => isset($this->options['custom_date_format']) ? $this->options['custom_date_format'] : '',
      '#dependency' => array(
        'edit-options-date-format' => $this->supported_date_types(),
      ),
    );
    $form['second_date_format'] = array(
      '#type' => 'select',
      '#title' => t('Second date format'),
      '#options' => $date_formats + array(
        'custom' => t('Custom'),
      ),
      '#description' => t('The date format which will be used for rendering dates other than today.'),
      '#default_value' => isset($this->options['second_date_format']) ? $this->options['second_date_format'] : 'small',
      '#dependency' => array(
        'edit-options-date-format' => array(
          'today time ago',
        ),
      ),
    );
    $form['second_date_format_custom'] = array(
      '#type' => 'textfield',
      '#title' => t('Custom date format of second date'),
      '#description' => t('If "Custom" is selected in "Second date format", see the <a href="@url" target="_blank">PHP manual</a> for date formats. Otherwise, enter the number of different time units to display, which defaults to 2.', array(
        '@url' => 'http://php.net/manual/function.date.php',
      )),
      '#default_value' => isset($this->options['second_date_format_custom']) ? $this->options['second_date_format_custom'] : '',
      // We have to use states instead of ctools dependency because dependency
      // doesn't handle multiple conditions.
'#states' => array(
        'visible' => array(
          '#edit-options-date-format' => array(
            'value' => 'today time ago',
          ),
          '#edit-options-second-date-format' => array(
            'value' => 'custom',
          ),
        ),
      ),
      // We have to use ctools dependency too because states doesn't add the
      // correct left margin to the element's wrapper.
'#dependency' => array(
        // This condition is handled by form API's states.
        // @code
        // 'edit-options-date-format' => array('today time ago'),
        // @endcode
'edit-options-second-date-format' => array(
          'custom',
        ),
      ),
    );
    $form['timezone'] = array(
      '#type' => 'select',
      '#title' => t('Timezone'),
      '#description' => t('Timezone to be used for date output.'),
      '#options' => array(
        '' => t('- Default site/user timezone -'),
      ) + system_time_zones(FALSE),
      '#default_value' => $this->options['timezone'],
      '#dependency' => array(
        'edit-options-date-format' => array_merge(array(
          'custom',
        ), array_keys($date_formats)),
      ),
    );
    parent::options_form($form, $form_state);
  }
  
  /**
   * Provide a list of all of the supported standard date types.
   *
   * @return array
   *   The list of supported formats.
   */
  private function supported_date_types() {
    return array(
      'custom',
      'raw time ago',
      'time ago',
      'today time ago',
      'raw time hence',
      'time hence',
      'raw time span',
      'time span',
      'raw time span',
      'inverse time span',
      'time span',
    );
  }
  
  /**
   * {@inheritdoc}
   */
  public function render($values) {
    $value = $this->get_value($values);
    // If the value isn't numeric, assume it's an SQL DATETIME.
    if (!empty($value) && !is_numeric($value)) {
      $value = strtotime($value);
    }
    if ($value) {
      $format = $this->options['date_format'];
      // The custom format can be either a number or a string, depending upon
      // what format is being used.
      $custom_format = NULL;
      if (in_array($format, $this->supported_date_types())) {
        $custom_format = $this->options['custom_date_format'];
      }
      $timezone = !empty($this->options['timezone']) ? $this->options['timezone'] : NULL;
      // Will be positive for a datetime in the past (ago), and negative for a
      // datetime in the future (hence).
      $time_diff = REQUEST_TIME - $value;
      switch ($format) {
        case 'raw time ago':
          return format_interval($time_diff, is_numeric($custom_format) ? $custom_format : 2);
        case 'time ago':
          $t_args = array(
            '%time' => format_interval($time_diff, is_numeric($custom_format) ? $custom_format : 2),
          );
          return t('%time ago', $t_args);
        case 'today time ago':
          $second_format = $this->options['second_date_format'];
          $second_custom_format = $this->options['second_date_format_custom'];
          if (format_date(REQUEST_TIME, 'custom', 'Y-m-d', $timezone) == format_date($value, 'custom', 'Y-m-d', $timezone)) {
            return t('%time ago', array(
              '%time' => format_interval($time_diff, is_numeric($custom_format) ? $custom_format : 2),
            ));
          }
          elseif ($second_format == 'custom') {
            if ($second_custom_format == 'r') {
              return format_date($value, $second_format, $second_custom_format, $timezone, 'en');
            }
            return format_date($value, $second_format, $second_custom_format, $timezone);
          }
          else {
            return format_date($value, $this->options['second_date_format'], '', $timezone);
          }
        case 'raw time hence':
          return format_interval(-$time_diff, is_numeric($custom_format) ? $custom_format : 2);
        case 'time hence':
          return t('%time hence', array(
            '%time' => format_interval(-$time_diff, is_numeric($custom_format) ? $custom_format : 2),
          ));
        case 'raw time span':
          return ($time_diff < 0 ? '-' : '') . format_interval(abs($time_diff), is_numeric($custom_format) ? $custom_format : 2);
        case 'inverse time span':
          return ($time_diff > 0 ? '-' : '') . format_interval(abs($time_diff), is_numeric($custom_format) ? $custom_format : 2);
        case 'time span':
          return t($time_diff < 0 ? '%time hence' : '%time ago', array(
            '%time' => format_interval(abs($time_diff), is_numeric($custom_format) ? $custom_format : 2),
          ));
        case 'custom':
          if ($custom_format == 'r') {
            return format_date($value, $format, $custom_format, $timezone, 'en');
          }
          return format_date($value, $format, t($custom_format), $timezone);
        default:
          // The custom format is not used in this scenario.
          return format_date($value, $format, '', $timezone);
      }
    }
  }
}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::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::can_expose | public | function | Determine if a handler can be exposed. | 2 | ||
| 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_form | public | function | Form for exposed handler options. | 2 | ||
| views_handler::expose_options | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | ||
| 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::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::options_validate | public | function | Validate the options form. | 4 | ||
| 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_button | public | function | Shortcut to display the expose/hide button. | 2 | ||
| 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::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_field::$additional_fields | public | property | Stores additional fields which get added to the query. The generated aliases are stored in $aliases. | |||
| views_handler_field::$aliases | public | property | ||||
| views_handler_field::$field_alias | public | property | ||||
| views_handler_field::$last_render_index | protected | property | Keeps track of the last render index. | |||
| views_handler_field::$original_value | public | property | The field value prior to any rewriting. | |||
| views_handler_field::add_additional_fields | public | function | Add 'additional' fields to the query. | |||
| views_handler_field::add_self_tokens | public | function | Add any special tokens this field might use for itself. | 4 | ||
| views_handler_field::admin_summary | public | function | Provide extra data to the administration form. | Overrides views_handler::admin_summary | ||
| views_handler_field::advanced_render | public | function | Render a field using advanced settings. | |||
| views_handler_field::allow_advanced_render | public | function | Determine if this field can allow advanced rendering. | 1 | ||
| views_handler_field::click_sort | public | function | Called to determine what to tell the clicksorter. | 1 | ||
| views_handler_field::click_sortable | public | function | Determine if this field is click sortable. | 1 | ||
| views_handler_field::construct | public | function | Construct a new field handler. | Overrides views_object::construct | 17 | |
| views_handler_field::document_self_tokens | public | function | Document any special tokens this field might use for itself. | 4 | ||
| views_handler_field::element_classes | public | function | Return the class of the field. | |||
| views_handler_field::element_label_classes | public | function | Return the class of the field's label. | |||
| views_handler_field::element_label_type | public | function | Return an HTML element for the label based upon the field's element type. | |||
| views_handler_field::element_type | public | function | Return an HTML element based upon the field's element type. | 2 | ||
| views_handler_field::element_wrapper_classes | public | function | Return the class of the field's wrapper. | |||
| views_handler_field::element_wrapper_type | public | function | Return an HTML element for the wrapper based upon the field's element type. | |||
| views_handler_field::get_elements | public | function | Provide a list of elements valid for field HTML. | |||
| views_handler_field::get_render_tokens | public | function | Get the 'render' tokens to use for advanced rendering. | |||
| views_handler_field::get_token_values_recursive | public | function | Recursive function to add replacements for nested query string parameters. | |||
| views_handler_field::get_value | public | function | Get the value that's supposed to be rendered. | 3 | ||
| views_handler_field::init | public | function | Init the handler with necessary data. | Overrides views_handler::init | 11 | |
| views_handler_field::is_value_empty | public | function | Checks if a field value is empty. | |||
| views_handler_field::label | public | function | Get this field's label. | |||
| views_handler_field::options_submit | public | function | Performs some cleanup tasks on the options array before saving it. | Overrides views_handler::options_submit | 1 | |
| views_handler_field::pre_render | public | function | Run before any fields are rendered. | 8 | ||
| views_handler_field::query | public | function | Called to add the field to a query. | 22 | ||
| views_handler_field::render_altered | public | function | Render this field as altered text, from a fieldset set by the user. | |||
| views_handler_field::render_as_link | public | function | Render this field as a link, with info from a fieldset set by the user. | |||
| views_handler_field::render_text | public | function | Perform an advanced text render for the item. | |||
| views_handler_field::render_trim_text | public | function | Trim the field down to the specified length. | |||
| views_handler_field::theme | public | function | Call out to the theme() function. | |||
| views_handler_field::theme_functions | public | function | Build a list of suitable theme functions for this view. | |||
| views_handler_field::tokenize_value | public | function | Replace a value with tokens from the last field. | |||
| views_handler_field::ui_name | public | function | Return a string representing this handler's name in the UI. | Overrides views_handler::ui_name | 1 | |
| views_handler_field::use_string_group_by | public | function | Determines if this field will be available as an option to group the result by in the style settings. | |||
| views_handler_field_date::options_form | public | function | Default options form provides the label widget that all fields should have. | Overrides views_handler_field::options_form | 1 | |
| views_handler_field_date::option_definition | public | function | Information about options for all kinds of purposes will be held here. | Overrides views_handler_field::option_definition | ||
| views_handler_field_date::render | public | function | Render the field. | Overrides views_handler_field::render | 2 | |
| views_handler_field_date::supported_date_types | private | function | Provide a list of all of the supported standard date types. | |||
| 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::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 | 
