You are here

Home » API reference » Views (for Drupal 7) 6.2 » views_handler_field_date.inc

class views_handler_field_date in Views (for Drupal 7) 6.2

Same name and namespace in other branches
  1. 6.3 handlers/views_handler_field_date.inc \views_handler_field_date
  2. 7.3 handlers/views_handler_field_date.inc \views_handler_field_date

A handler to provide proper displays for dates.

Hierarchy

Expanded class hierarchy of views_handler_field_date

Related topics

Views' field handlers
Handlers to tell Views how to build and display fields.
10 string references to 'views_handler_field_date'
aggregator_views_data in modules/aggregator.views.inc
Implementation of hook_views_data()
comment_views_data in modules/comment.views.inc
Implementation of hook_views_data()
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()

... See full list

File

handlers/views_handler_field_date.inc, line 7

View source 
class views_handler_field_date extends views_handler_field {
  function option_definition() {
    $options = parent::option_definition();
    $options['date_format'] = array(
      'default' => 'small',
    );
    $options['custom_date_format'] = array(
      'default' => '',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $time = time();
    $form['date_format'] = array(
      '#type' => 'select',
      '#title' => t('Date format'),
      '#options' => array(
        'small' => t('Short date format') . ' ' . format_date($time, 'small'),
        'medium' => t('Medium date format') . ' ' . format_date($time, 'medium'),
        'large' => t('Long date format') . ' ' . format_date($time, 'large'),
        'custom' => t('Custom'),
        'raw time ago' => t('Time ago'),
        'time ago' => t('Time ago (with "ago" appended)'),
        'raw time span' => t('Time span (future dates start with - )'),
        '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 <a href="http://us.php.net/manual/en/function.date.php" target="_blank">the PHP docs</a> for date formats. If "Time ago", enter the number of different time units to display, which defaults to 2.'),
      '#default_value' => isset($this->options['custom_date_format']) ? $this->options['custom_date_format'] : '',
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'edit-options-date-format' => array(
          'custom',
          'raw time ago',
          'time ago',
          'raw time span',
          'time span',
        ),
      ),
    );
  }
  function render($values) {
    $value = $values->{$this->field_alias};
    $format = $this->options['date_format'];
    if (in_array($format, array(
      'custom',
      'raw time ago',
      'time ago',
      'raw time span',
      'time span',
    ))) {
      $custom_format = $this->options['custom_date_format'];
    }
    if ($value) {
      $time_diff = time() - $value;

      // will be positive for a datetime in the past (ago), and negative for a datetime in the future (hence)
      switch ($format) {
        case 'raw time ago':
          return format_interval($time_diff, is_numeric($custom_format) ? $custom_format : 2);
        case 'time ago':
          return t('%time ago', 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 '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, null, 'en');
          }
          return format_date($value, $format, $custom_format);
        default:
          return format_date($value, $format);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_handler::accept_exposed_input function Take input from exposed filters and assign to this handler, if necessary. 1
views_handler::access function Check whether current user has access to this handler. 5
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 5
views_handler::can_expose function Determine if a handler can be exposed. 1
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot. 7
views_handler::exposed_form function Render our chunk of the exposed filter form when selecting 1
views_handler::exposed_info function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit function Submit the exposed filter form
views_handler::exposed_validate function Validate the exposed filter form 4
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on. 1
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options. 1
views_handler::extra_options_submit 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 function Validate the options form.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options 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 function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin. 1
views_handler::options_submit 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::options_validate function Validate the options form. 1
views_handler::pre_query function Run before the view is built. 1
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name function Return a string representing this handler's name in the UI. 5
views_handler::validate function Validates the handler against the complete View.
views_handler_field::$aliases property
views_handler_field::$field_alias property
views_handler_field::add_additional_fields function Add 'additional' fields to the query.
views_handler_field::add_self_tokens function Add any special tokens this field might use for itself. 4
views_handler_field::admin_summary function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render function Render a field using advanced settings.
views_handler_field::allow_advanced_render function Determine if this field can allow advanced rendering. 1
views_handler_field::click_sort function Called to determine what to tell the clicksorter. 1
views_handler_field::click_sortable function Determine if this field is click sortable.
views_handler_field::construct function Construct a new field handler. Overrides views_object::construct 18
views_handler_field::document_self_tokens function Document any special tokens this field might use for itself. 4
views_handler_field::element_type function Return DIV or SPAN based upon the field's element type. 2
views_handler_field::get_render_tokens function Get the 'render' tokens to use for advanced rendering.
views_handler_field::init function init the handler with necessary data. Overrides views_handler::init 11
views_handler_field::label function Get this field's label.
views_handler_field::pre_render function Run before any fields are rendered. 6
views_handler_field::query function Called to add the field to a query. Overrides views_handler::query 19
views_handler_field::render_altered function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link function Render this field as a link, with the info from a fieldset set by the user.
views_handler_field::render_text function Perform an advanced text render for the item.
views_handler_field::render_trim_text function Trim the field down to the specified length.
views_handler_field::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
views_handler_field::theme_functions function
views_handler_field_date::options_form function Default options form that provides the label widget that all fields should have. Overrides views_handler_field::options_form 1
views_handler_field_date::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
views_handler_field_date::render function Render the field. Overrides views_handler_field::render 2
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::destroy function 2
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. 1
views_object::set_default_options 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::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults function 1