You are here

Home » API reference » Date 7 » date_views_argument_handler.inc

class date_views_argument_handler in Date 7

Same name and namespace in other branches
  1. 8 date_views/includes/date_views_argument_handler.inc \date_views_argument_handler
  2. 7.3 date_views/includes/date_views_argument_handler.inc \date_views_argument_handler
  3. 7.2 date_views/includes/date_views_argument_handler.inc \date_views_argument_handler

Date API argument handler.

Hierarchy

Expanded class hierarchy of date_views_argument_handler

2 string references to 'date_views_argument_handler'
date_field_views_data_alter in date_views/date_views.module
Create a Views field for each date column we care about to supplement the generic 'entity_id' and 'revision_id' fields that are automatically created.
date_views_views_data in date_views/includes/date_views.views.inc
Implementation of hook_views_data()

File

date_views/includes/date_views_argument_handler.inc, line 11
Date API views argument handler.

View source 
class date_views_argument_handler extends views_handler_argument_date {
  function construct() {
    parent::construct();
    module_load_include('inc', 'date_api', 'date_api_sql');
    $this->date_handler = new date_sql_handler();
    $this->date_handler
      ->construct();
  }

  /**
   * Get granularity and use it to create the formula and a format
   * for the results.
   */
  function init(&$view, &$options) {
    parent::init($view, $options);

    // Identify the type of display we're using.
    $this->display_handler = $view->display_handler->definition['handler'];

    // Add a date handler to the display.
    $this->date_handler->granularity = $this->options['granularity'];
    $this->format = $this->date_handler
      ->views_formats($this->date_handler->granularity, 'display');
    $this->sql_format = $this->date_handler
      ->views_formats($this->date_handler->granularity, 'sql');
    if (empty($this->view->date_info)) {
      $this->view->date_info = new stdClass();
    }

    // Set the view range, do this only if not already set in case there are multiple date arguments.
    if (empty($this->view->date_info->min_allowed_year)) {
      $range = date_range_years($this->options['year_range']);
      $this->view->date_info->min_allowed_year = !empty($range) && is_array($range) ? $range[0] : variable_get('min_allowed_year', 100);
      $this->view->date_info->max_allowed_year = !empty($range) && is_array($range) ? $range[1] : variable_get('max_allowed_year', 4000);
    }
    if (empty($this->view->date_info->date_fields)) {
      $this->view->date_info->date_fields = array();
    }
    $this->view->date_info->date_fields = array_merge($this->view->date_info->date_fields, $this->options['date_fields']);
  }

  /**
   * Default value for the date_fields option.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['date_fields'] = array(
      'default' => array(),
    );
    $options['year_range'] = array(
      'default' => '-3:+3',
    );
    $options['date_method'] = array(
      'default' => 'OR',
    );
    $options['granularity'] = array(
      'default' => 'month',
    );
    return $options;
  }

  /**
   * Add a form element to select date_fields for this argument.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $options = $this->date_handler
      ->date_parts();
    unset($options['second'], $options['minute']);
    $options += array(
      'week' => t('Week', array(), array(
        'context' => 'datetime',
      )),
    );
    $form['granularity'] = array(
      '#title' => t('Granularity'),
      '#type' => 'radios',
      '#options' => $options,
      '#default_value' => $this->options['granularity'],
      '#multiple' => TRUE,
      '#description' => t("Select the type of date value to be used in defaults, summaries, and navigation. For example, a granularity of 'month' will set the default date to the current month, summarize by month in summary views, and link to the next and previous month when using date navigation."),
    );
    $form['year_range'] = array(
      '#title' => t('Date year range'),
      '#type' => 'textfield',
      '#default_value' => $this->options['year_range'],
      '#description' => t("Set the allowable minimum and maximum year range for this argument, either a -X:+X offset from the current year, like '-3:+3' or an absolute minimum and maximum year, like '2005:2010' . When the argument is set to a date outside the range, the page will be returned as 'Page not found (404)' ."),
    );
    $fields = date_views_fields($this->view->base_table);
    $options = array();
    foreach ($fields['name'] as $name => $field) {
      $options[$name] = $field['label'];
    }

    // If this argument was added as a CCK field argument and no other date field
    // has been chosen, update the default with the right date.
    if (empty($this->options['date_fields']) && $this->field != 'date_argument') {
      $this->options['date_fields'] = array(
        $this->table . '.' . $this->field,
      );
    }
    $form['date_fields'] = array(
      '#title' => t('Date field(s)'),
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => $this->options['date_fields'],
      '#multiple' => TRUE,
      '#description' => t("Select one or more date fields to filter with this argument. Do not select both the 'From date' and 'To date' for CCK date fields, only one of them is needed."),
    );
    $form['date_method'] = array(
      '#title' => t('Method'),
      '#type' => 'radios',
      '#options' => array(
        'OR' => t('OR'),
        'AND' => t('AND'),
      ),
      '#default_value' => $this->options['date_method'],
      '#description' => t('Method of handling multiple date fields in the same query. Return items that have any matching date field (date = field_1 OR field_2), or only those with matches in all selected date fields (date = field_1 AND field_2). '),
    );
  }
  function options_validate(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_validate($form, $form_state);
    if ($form_state['values']['form_id'] == 'views_ui_config_item_form') {
      $check_fields = array_filter($form_state['values']['options']['date_fields']);
      if (empty($check_fields)) {
        form_error($form['date_fields'], t('You must select at least one date field for this argument.'));
      }
      if (!preg_match('/^(?:\\-[0-9]{1,4}|[0-9]{4}):(?:[\\+|\\-][0-9]{1,4}|[0-9]{4})$/', $form_state['values']['options']['year_range'])) {
        form_error($form['year_range'], t('Date year range must be in the format -9:+9, 2005:2010, -9:2010, or 2005:+9'));
      }
    }
  }
  function options_submit(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_submit($form, $form_state);
    if ($form_state['values']['form_id'] == 'views_ui_config_item_form') {
      $form_state['values']['options']['date_fields'] = array_filter($form_state['values']['options']['date_fields']);
    }
  }

  // Update the summary values to show selected granularity.
  function admin_summary() {
    $fields = date_views_fields($this->view->base_table);
    if (!empty($this->options['date_fields'])) {
      $output = array();
      foreach ($this->options['date_fields'] as $field) {
        $output[] = $fields['name'][$field]['label'];
      }
      return implode('<br />' . $this->options['date_method'] . ' ', $output);
    }
    else {
      return parent::admin_summary();
    }
  }

  /**
   * Set the empty argument value to the current date,
   * formatted appropriately for this argument.
   */
  function get_default_argument($raw = FALSE) {
    $granularity = $this->options['granularity'];
    if (!$raw && $this->options['default_argument_type'] == 'date') {
      if ($granularity == 'week') {
        $now = date_now();
        $week = date_week($now);
        return date_format($now, 'Y') . '-W' . $week;
      }
      else {
        return date($this
          ->format(), REQUEST_TIME);
      }
    }
    else {
      return parent::get_default_argument($raw);
    }
  }
  function format() {
    if (!empty($this->options['granularity'])) {
      $date_handler = new date_sql_handler();
      return $date_handler
        ->views_formats($this->options['granularity']);
    }
    else {
      return !empty($this->options[$this->option_name]) ? $this->options[$this->option_name] : 'Y-m';
    }
  }

  /**
   * Provide a link to the next level of the view from the summary.
   */
  function summary_name($data) {
    $format = $this->date_handler
      ->views_formats($this->options['granularity'], 'display');
    $value = $data->{$this->name_alias};
    $range = $this->date_handler
      ->arg_range($value);
    return date_format_date($range[0], 'custom', $format);
  }

  /**
   * Provide the argument to use to link from the summary to the next level;
   * this will be called once per row of a summary, and used as part of
   * $view->get_url().
   *
   * @param $data
   *   The query results for the row.
   */
  function summary_argument($data) {
    $format = $this->date_handler
      ->views_formats($this->options['granularity'], 'sql');
    $value = $data->{$this->name_alias};
    $range = $this->date_handler
      ->arg_range($value);
    return date_format_date($range[0], 'custom', $format);
  }

  /**
   * Provide a link to the next level of the view from the argument.
   */
  function title() {
    $format = $this->date_handler
      ->views_formats($this->options['granularity'], 'display');
    $range = $this->date_handler
      ->arg_range($this->argument);
    return date_format_date($range[0], 'custom', $format);
  }

  /**
   * Create a summary query that matches the granularity.
   *
   * Needed or Views will do a groupby on the complete date instead
   * of only the part of the date actually used in the argument.
   */
  function summary_query() {
    $this
      ->get_query_fields();

    // No way to do summaries on more than one field at a time.
    if (count($this->query_fields) > 1) {
      return;
    }

    // Cause query->ensure_table to perform the correct join.
    $this->table = $this->query_fields[0]['field']['table_name'];
    $this
      ->ensure_my_table();
    $field = $this->query_fields[0]['field'];
    $date_handler = $this->query_fields[0]['date_handler'];

    // Get the SQL format for this granularity, like Y-m,
    // and use that as the grouping value.
    $format = $date_handler
      ->views_formats($this->options['granularity'], 'sql');
    $this->formula = $date_handler
      ->sql_format($format, $date_handler
      ->sql_field($field['fullname']));

    // Add the computed field.
    $this->base_alias = $this->name_alias = $this->query
      ->add_field(NULL, $this->formula, $field['query_name']);
    $this->query
      ->set_count_field(NULL, $this->formula, $field['query_name']);
    return $this
      ->summary_basics(FALSE);
  }
  function get_query_fields() {
    $fields = date_views_fields($this->view->base_table);
    $fields = $fields['name'];
    $min_date = isset($this->min_date) ? $this->min_date : NULL;
    $min_utc = isset($this->min_utc) ? $this->min_utc : NULL;
    $max_date = isset($this->max_date) ? $this->max_date : NULL;
    $max_utc = isset($this->max_utc) ? $this->max_utc : NULL;
    $this->query_fields = array();
    foreach ($this->options['date_fields'] as $delta => $name) {
      if (array_key_exists($name, $fields) && ($field = $fields[$name])) {
        $date_handler = new date_sql_handler();
        $date_handler
          ->construct($field['sql_type'], date_default_timezone());
        $date_handler->granularity = $this->options['granularity'];
        date_views_set_timezone($date_handler, $this, $field);
        $this->query_fields[] = array(
          'field' => $field,
          'date_handler' => $date_handler,
        );
      }
    }
  }

  /**
   * Make sure the date field is added to the query.
   *
   * Do this in pre_query() so it will get done even if the argument
   * is the wildcard, since query() is skipped when the wildcard is used.
   */
  function pre_query() {

    // Unset invalid date values before the query runs.
    if (!empty($this->view->args) && count($this->view->args) > $this->position) {
      $argument = $this->view->args[$this->position];
      $parts = $this->date_handler
        ->arg_parts($argument);
      if (empty($parts[0]['date']) && empty($parts[0]['period'])) {
        unset($this->view->args[$this->position]);
      }
    }
  }

  /**
   * Set up the query for this argument.
   *
   * The argument sent may be found at $this->argument.
   */
  function query() {
    $this
      ->get_query_fields();
    $block_identifier = date_block_identifier($this->view);
    if (!empty($this->view->block_identifier) || isset($_GET[$block_identifier])) {

      // Retrieve the block arguments in a way that will work for
      // urls like user/%/calendar/2009-04.
      if (!empty($_GET[$block_identifier])) {
        $path_args = explode('/', $this->view
          ->get_path());
        $mini_args = explode('/', $_GET[$block_identifier]);
        foreach ($path_args as $pos => $key) {
          if ($path_args[$pos] != '%') {
            unset($mini_args[$pos]);
          }
        }

        // Get rid of gaps in the array caused by embedded args.
        $mini_args = array_values($mini_args);
        $this->view->args = $mini_args;
      }
      $i = 0;
      foreach ($this->view->argument as $argument) {
        if ($argument->field == 'date_argument') {
          $this->argument = $this->view->args[$argument->position];
          break;
        }
        $i++;
      }
    }
    $parts = $this->date_handler
      ->arg_parts($this->argument);
    foreach ($parts as $type) {
      foreach ($type as $part) {
        foreach ($part as $key => $value) {
          if (!empty($value)) {

            // The last part evaluated is the one that will 'stick'
            // as the date type.
            $this->granularity = $key;
            $this->{$key} = $value;
          }
        }
      }
    }
    $range = $this->date_handler
      ->arg_range($this->argument);
    $min_date = $range[0];
    $max_date = $range[1];
    $this->min_date = $min_date;
    $this->max_date = $max_date;

    // See if we're outside the allowed date range for our argument.
    if (date_format($min_date, 'Y') < $this->view->date_info->min_allowed_year || date_format($max_date, 'Y') > $this->view->date_info->max_allowed_year) {
      $this->forbid = TRUE;
      $this->query
        ->add_where_expression('date', "0=1", array());
      return;
    }

    // The second option seems to work better in the block view if
    // set to something other than the original value.
    // Need to keep an eye on this to be sure nothing else breaks.

    //$format = $this->date_handler->views_formats($this->options['granularity'], 'sql');
    $format = $this->date_handler
      ->views_formats($this->granularity, 'sql');
    if (!empty($this->query_fields)) {

      // Use set_where_group() with the selected date_method
      // of 'AND' or 'OR' to create the where clause.
      $this->query
        ->set_where_group($this->options['date_method'], 'date');
      foreach ($this->query_fields as $query_field) {
        $field = $query_field['field'];
        $date_handler = $query_field['date_handler'];
        if ($field['table_name'] != $this->table || !empty($this->relationship)) {
          $this->related_table_alias = $this->query
            ->queue_table($field['table_name'], $this->relationship);
        }
        $table_alias = !empty($this->related_table_alias) ? $this->related_table_alias : $field['table_name'];
        $from_field = str_replace($field['table_name'] . '_', $table_alias . '.', $field['fromto'][0]);
        $to_field = str_replace($field['table_name'] . '_', $table_alias . '.', $field['fromto'][1]);
        if ($this->granularity != 'week') {
          $from = $date_handler
            ->sql_where_format($format, $from_field, '<=', date_format($max_date, $format));
          $to = $date_handler
            ->sql_where_format($format, $to_field, '>=', date_format($min_date, $format));
        }
        else {
          $format = DATE_FORMAT_DATETIME;
          $from = $date_handler
            ->sql_where_date('DATE', $from_field, '<=', date_format($max_date, $format));
          $to = $date_handler
            ->sql_where_date('DATE', $to_field, '>=', date_format($min_date, $format));
        }
        $sql = str_replace('***table***', $field['table_name'], "({$from} AND {$to})");
        if ($sql) {
          $this->query
            ->add_where_expression('date', $sql, array());
        }
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
date_views_argument_handler::admin_summary function Provide text for the administrative summary. Overrides views_handler::admin_summary
date_views_argument_handler::construct function Views handlers use a special construct function. Overrides views_handler_argument_formula::construct
date_views_argument_handler::format function
date_views_argument_handler::get_default_argument function Set the empty argument value to the current date, formatted appropriately for this argument. Overrides views_handler_argument_date::get_default_argument
date_views_argument_handler::get_query_fields function
date_views_argument_handler::init function Get granularity and use it to create the formula and a format for the results. Overrides views_handler_argument::init
date_views_argument_handler::options_form function Add a form element to select date_fields for this argument. Overrides views_handler_argument::options_form
date_views_argument_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. Overrides views_handler_argument::options_submit
date_views_argument_handler::options_validate function Validate the options form. Overrides views_handler_argument::options_validate
date_views_argument_handler::option_definition function Default value for the date_fields option. Overrides views_handler_argument::option_definition
date_views_argument_handler::pre_query function Make sure the date field is added to the query. Overrides views_handler::pre_query
date_views_argument_handler::query function Set up the query for this argument. Overrides views_handler_argument_formula::query
date_views_argument_handler::summary_argument function Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->get_url(). Overrides views_handler_argument::summary_argument
date_views_argument_handler::summary_name function Provide a link to the next level of the view from the summary. Overrides views_handler_argument::summary_name
date_views_argument_handler::summary_query function Create a summary query that matches the granularity. Overrides views_handler_argument_formula::summary_query
date_views_argument_handler::title function Provide a link to the next level of the view from the argument. Overrides views_handler_argument::title
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::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::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::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_argument::$argument public property
views_handler_argument::$name_field public property The field to use for the name to use in the summary.
views_handler_argument::$name_table public property The table to use for the name, if not the same table as the argument.
views_handler_argument::$validator public property
views_handler_argument::$value public property 1
views_handler_argument::default_access_denied public function Default action: access denied.
views_handler_argument::default_action public function Handle the default action, which means our argument wasn't present.
views_handler_argument::default_actions public function List of default behaviors for this argument if the argument is not present. 4
views_handler_argument::default_default public function This just returns true.
views_handler_argument::default_empty public function Default action: empty.
views_handler_argument::default_ignore public function Default action: ignore.
views_handler_argument::default_not_found public function Default action: not found.
views_handler_argument::default_summary public function Default action: summary.
views_handler_argument::default_summary_form public function Form for selecting further summary options.
views_handler_argument::exception_title public function Work out which title to use.
views_handler_argument::export_summary public function Export handler for summary export.
views_handler_argument::export_validation public function Export handler for validation export.
views_handler_argument::get_plugin public function Get the display or row plugin, if it exists.
views_handler_argument::get_title public function Called by the view object to get the title.
views_handler_argument::get_value public function Get the value of this argument.
views_handler_argument::has_default_argument public function Determine if the argument is set to provide a default argument.
views_handler_argument::is_exception public function
views_handler_argument::needs_style_plugin public function Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::process_summary_arguments public function Process the summary arguments for display.
views_handler_argument::set_argument public function Set the input for this argument.
views_handler_argument::set_breadcrumb public function Give an argument the opportunity to modify the breadcrumb, if it wants. 3
views_handler_argument::summary_basics public function Some basic summary behavior.
views_handler_argument::summary_name_field public function Add the name field, which is the field displayed in summary queries.
views_handler_argument::summary_sort public function Sorts the summary based upon the user's selection.
views_handler_argument::uses_breadcrumb public function Determine if the argument can generate a breadcrumb.
views_handler_argument::validate_arg public function Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument public function Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic public function Provide a basic argument validation. 1
views_handler_argument::validate_fail public function How to act if validation fails.
views_handler_argument_date::$arg_format public property
views_handler_argument_date::$option_name public property
views_handler_argument_date::default_argument_form public function Add an option to set the default value to the current date. Overrides views_handler_argument::default_argument_form
views_handler_argument_date::export_plugin public function Adapt the export mechanism. Overrides views_handler_argument::export_plugin
views_handler_argument_date::get_sort_name public function Return a description of how the argument would normally be sorted. Overrides views_handler_argument::get_sort_name
views_handler_argument_formula::$formula public property
views_handler_argument_formula::get_formula public function
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::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