You are here

Home » API reference » Date 7.2 » date_views_argument_handler.inc

class date_views_argument_handler in Date 7.2

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 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

1 string reference to 'date_views_argument_handler'
date_views_views_data in date_views/includes/date_views.views.inc
Implements hook_views_data().

File

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

View source 
class date_views_argument_handler extends date_views_argument_handler_simple {

  /**
   * {@inheritdoc}
   */
  public function init(&$view, &$options) {
    parent::init($view, $options);
    if (empty($this->view->date_info)) {
      $this->view->date_info = new stdClass();
    }
    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']);
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['date_fields'] = array(
      'default' => array(),
    );
    $options['date_method'] = array(
      'default' => 'OR',
    );
    $options['date_group'] = array(
      'default' => 'date',
    );

    // There is no easy way to do summary queries on multiple fields, so remove
    // that option; leaving this variable in place causes problems with Features
    // exports.
    unset($options['summary']);
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $fields = date_views_fields($this->base_table);
    $options = array();
    foreach ($fields['name'] as $name => $field) {
      $options[$name] = $field['label'];
    }
    $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."),
    );
    $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).'),
    );
    $form['date_group'] = array(
      '#type' => 'hidden',
      '#value' => $this->options['date_group'],
    );
  }

  /**
   * {@inheritdoc}
   */
  public function options_validate(&$form, &$form_state) {

    // Views will whine if we don't have something for the these values even
    // though we removed the option for summaries.
    $form_state['values']['options']['summary']['format'] = 'none';
    $form_state['values']['options']['summary']['options']['none'] = array();

    // 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.'));
      }
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function admin_summary() {
    $fields = date_views_fields($this->base_table);
    if (!empty($this->options['date_fields'])) {
      $output = array();
      foreach ($this->options['date_fields'] as $field) {
        if (array_key_exists($field, $fields['name'])) {
          $output[] = $fields['name'][$field]['label'];
        }
      }
      return implode('<br />' . $this->options['date_method'] . ' ', $output);
    }
    else {
      return parent::admin_summary();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function default_actions($which = NULL) {
    $defaults = parent::default_actions();

    // There is no easy way to do summary queries on multiple fields, so remove
    // that option.
    unset($defaults['summary']);
    if ($which) {
      if (!empty($defaults[$which])) {
        return $defaults[$which];
      }
    }
    else {
      return $defaults;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function query($group_by = FALSE) {

    // @todo Not doing anything with $group_by yet, need to figure out what has
    // to be done.
    if ($this
      ->date_forbid()) {
      return;
    }
    $this
      ->get_query_fields();
    $this->query
      ->set_where_group($this->options['date_method'], $this->options['date_group']);
    $this->granularity = $this->date_handler
      ->arg_granularity($this->argument);
    $format = $this->date_handler
      ->views_formats($this->granularity, 'sql');
    $this->placeholders = array();
    if (!empty($this->query_fields)) {

      // Use set_where_group() with the selected date_method of 'AND' or 'OR'
      // to create the where clause.
      foreach ($this->query_fields as $count => $query_field) {
        $field = $query_field['field'];
        $this->date_handler = $query_field['date_handler'];
        $this->field = $field['field_name'];
        $this->real_field = $field['field_name'];
        $this->table = $field['table_name'];
        $this->original_table = $field['table_name'];
        if ($field['table_name'] != $this->table || !empty($this->relationship)) {
          $this->table = $this->query
            ->ensure_table($field['table_name'], $this->relationship);
        }
        elseif (empty($this->relationship)) {
          $this->table_alias = NULL;
        }
        parent::query($group_by);
        $this->placeholders = array_merge($this->placeholders, $this->date_handler->placeholders);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function get_query_fields() {
    $fields = date_views_fields($this->base_table);
    $fields = $fields['name'];
    $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($field['sql_type'], date_default_timezone());
        $date_handler->granularity = $this->options['granularity'];
        $date_handler->db_timezone = date_get_timezone_db($field['tz_handling']);
        $date_handler->local_timezone = date_get_timezone($field['tz_handling']);
        date_views_set_timezone($date_handler, $this, $field);
        $this->query_fields[] = array(
          'field' => $field,
          'date_handler' => $date_handler,
        );
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
date_views_argument_handler::admin_summary public function Provide text for the administrative summary. Overrides views_handler::admin_summary
date_views_argument_handler::default_actions public function List of default behaviors for this argument if the argument is not present. Overrides views_handler_argument::default_actions
date_views_argument_handler::get_query_fields public function
date_views_argument_handler::init public function Init the handler with necessary data. Overrides date_views_argument_handler_simple::init
date_views_argument_handler::options_form public function Build the options form. Overrides date_views_argument_handler_simple::options_form
date_views_argument_handler::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. Overrides views_handler_argument::options_submit
date_views_argument_handler::options_validate public function Validate the options form. Overrides date_views_argument_handler_simple::options_validate
date_views_argument_handler::option_definition public function Information about options for all kinds of purposes will be held here. Overrides date_views_argument_handler_simple::option_definition
date_views_argument_handler::query public function Build the query based upon the formula Overrides date_views_argument_handler_simple::query
date_views_argument_handler_simple::date_forbid public function Add a callback.
date_views_argument_handler_simple::format public function
date_views_argument_handler_simple::get_default_argument public function Set the empty argument value to the current date. Overrides views_handler_argument_date::get_default_argument
date_views_argument_handler_simple::summary_argument public function Provide the argument to use to link from the summary to the next level. Overrides views_handler_argument::summary_argument
date_views_argument_handler_simple::summary_name public function Provides the name to use for the summary. Overrides views_handler_argument::summary_name
date_views_argument_handler_simple::summary_query public function Build the summary query based on a formula Overrides views_handler_argument_formula::summary_query
date_views_argument_handler_simple::title public function Get the title this argument will assign the view, given 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::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::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_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::construct public function Views handlers use a special construct function. Overrides views_handler_argument::construct 6
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