public function Date::buildOptionsForm

Same name in this branch
  1. 8.x drupal/core/modules/views/lib/Drupal/views/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date::buildOptionsForm()
  2. 8.x drupal/core/modules/views/lib/Drupal/views/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date::buildOptionsForm()

Default options form that provides the label widget that all fields should have.

Overrides FieldPluginBase::buildOptionsForm

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/field/Date.php, line 31
Definition of Drupal\views\Plugin\views\field\Date.

Class

Date
A handler to provide proper displays for dates.

Namespace

Drupal\views\Plugin\views\field

Code

public function buildOptionsForm(&$form, &$form_state) {
  $date_formats = array();
  $date_types = system_get_date_formats();
  foreach ($date_types as $machine_name => $value) {
    $date_formats[$machine_name] = t('@name format: @date', array(
      '@name' => $value['name'],
      '@date' => format_date(REQUEST_TIME, $machine_name),
    ));
  }
  $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)'),
      '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 <a href="http://us.php.net/manual/en/function.date.php" target="_blank">the PHP docs</a> for date formats. Otherwise, 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'] : '',
  );

  // Setup #states for all possible date_formats on the custom_date_format form element.
  foreach (array(
    'custom',
    'raw time ago',
    'time ago',
    'raw time hence',
    'time hence',
    'raw time span',
    'time span',
    'raw time span',
    'inverse time span',
    'time span',
  ) as $custom_date_possible) {
    $form['custom_date_format']['#states']['visible'][] = array(
      ':input[name="options[date_format]"]' => array(
        'value' => $custom_date_possible,
      ),
    );
  }
  $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'],
  );
  foreach (array_merge(array(
    'custom',
  ), array_keys($date_formats)) as $timezone_date_formats) {
    $form['timezone']['#states']['visible'][] = array(
      ':input[name="options[date_format]"]' => array(
        'value' => $timezone_date_formats,
      ),
    );
  }
  parent::buildOptionsForm($form, $form_state);
}