class SearchApiViewsHandlerArgumentDate in Search API 7

Defines a contextual filter searching for a date or date range.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_argument
    class \SearchApiViewsHandlerArgument
    class \SearchApiViewsHandlerArgumentDate

Expanded class hierarchy of SearchApiViewsHandlerArgumentDate

1 string reference to 'SearchApiViewsHandlerArgumentDate'

_search_api_views_add_handlers in contrib/search_api_views/search_api_views.views.inc: Adds handler definitions for a field to a Views data table definition.

File

contrib/search_api_views/includes/handler_argument_date.inc, line 11: Contains the SearchApiViewsHandlerArgumentDate class.

View source

class SearchApiViewsHandlerArgumentDate extends SearchApiViewsHandlerArgument {

  /**
   * {@inheritdoc}
   */
  public function query($group_by = FALSE) {
    if (empty($this->value)) {
      $this
        ->fillValue();
      if ($this->value === FALSE) {
        $this
          ->abort();
        return;
      }
    }
    $outer_conjunction = strtoupper($this->operator);
    if (empty($this->options['not'])) {
      $operator = '=';
      $inner_conjunction = 'OR';
    }
    else {
      $operator = '<>';
      $inner_conjunction = 'AND';
    }
    if (!empty($this->value)) {
      if (!empty($this->value)) {
        $outer_filter = $this->query
          ->createFilter($outer_conjunction);
        foreach ($this->value as $value) {
          $value_filter = $this->query
            ->createFilter($inner_conjunction);
          $values = explode(';', $value);
          $values = array_map(array(
            $this,
            'getTimestamp',
          ), $values);
          if (in_array(FALSE, $values, TRUE)) {
            $this
              ->abort();
            return;
          }
          $is_range = count($values) > 1;
          $inner_filter = $is_range ? $this->query
            ->createFilter('AND') : $value_filter;
          $range_op = empty($this->options['not']) ? '>=' : '<';
          $inner_filter
            ->condition($this->real_field, $values[0], $is_range ? $range_op : $operator);
          if ($is_range) {
            $range_op = empty($this->options['not']) ? '<=' : '>';
            $inner_filter
              ->condition($this->real_field, $values[1], $range_op);
            $value_filter
              ->filter($inner_filter);
          }
          $outer_filter
            ->filter($value_filter);
        }
        $this->query
          ->filter($outer_filter);
      }
    }
  }

  /**
   * Converts a value to a timestamp, if it isn't one already.
   *
   * @param string|int $value
   *   The value to convert. Either a timestamp, or a date/time string as
   *   recognized by strtotime().
   *
   * @return int|false
   *   The parsed timestamp, or FALSE if an illegal string was passed.
   */
  public function getTimestamp($value) {
    if (is_numeric($value)) {
      return $value;
    }
    return strtotime($value);
  }

  /**
   * Fills $this->value with data from the argument.
   */
  protected function fillValue() {
    if (!empty($this->options['break_phrase'])) {

      // Set up defaults:
      if (!isset($this->value)) {
        $this->value = array();
      }
      if (!isset($this->operator)) {
        $this->operator = 'OR';
      }
      if (empty($this->argument)) {
        return;
      }
      if (preg_match('/^([-\\d;:\\s]+\\+)*[-\\d;:\\s]+$/', $this->argument)) {

        // The '+' character in a query string may be parsed as ' '.
        $this->value = explode('+', $this->argument);
      }
      elseif (preg_match('/^([-\\d;:\\s]+,)*[-\\d;:\\s]+$/', $this->argument)) {
        $this->operator = 'AND';
        $this->value = explode(',', $this->argument);
      }

      // Keep an 'error' value if invalid strings were given.
      if (!empty($this->argument) && (empty($this->value) || !is_array($this->value))) {
        $this->value = FALSE;
      }
    }
    else {
      $this->value = array(
        $this->argument,
      );
    }
  }

  /**
   * Aborts the associated query due to an illegal argument.
   */
  protected function abort() {
    $variables['!field'] = $this->definition['group'] . ': ' . $this->definition['title'];
    $this->query
      ->abort(t('Illegal argument passed to !field contextual filter.', $variables));
  }

  /**
   * Computes the title this argument will assign the view, given the argument.
   *
   * @return string
   *   A title fitting for the passed argument.
   */
  public function title() {
    if (!empty($this->argument)) {
      if (empty($this->value)) {
        $this
          ->fillValue();
      }
      $dates = array();
      foreach ($this->value as $date) {
        $date_parts = explode(';', $date);
        $ts = $this
          ->getTimestamp($date_parts[0]);
        $datestr = format_date($ts, 'short');
        if (count($date_parts) > 1) {
          $ts = $this
            ->getTimestamp($date_parts[1]);
          $datestr .= ' - ' . format_date($ts, 'short');
        }
        if ($datestr) {
          $dates[] = $datestr;
        }
      }
      return $dates ? implode(', ', $dates) : check_plain($this->argument);
    }
    return check_plain($this->argument);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiViewsHandlerArgument::$operator	public	property	The operator to use for multiple arguments.
SearchApiViewsHandlerArgument::$query	public	property	The associated views query object. Overrides views_handler::$query	5
SearchApiViewsHandlerArgument::default_actions	public	function	Provide a list of default behaviors for this argument if the argument is not present. Overrides views_handler_argument::default_actions
SearchApiViewsHandlerArgument::options_form	public	function	Build the options form. Overrides views_handler_argument::options_form	2
SearchApiViewsHandlerArgument::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_handler_argument::option_definition	2
SearchApiViewsHandlerArgument::uses_breadcrumb	public	function	Determine if the argument can generate a breadcrumb. Overrides views_handler_argument::uses_breadcrumb
SearchApiViewsHandlerArgumentDate::abort	protected	function	Aborts the associated query due to an illegal argument.
SearchApiViewsHandlerArgumentDate::fillValue	protected	function	Fills $this->value with data from the argument.
SearchApiViewsHandlerArgumentDate::getTimestamp	public	function	Converts a value to a timestamp, if it isn't one already.
SearchApiViewsHandlerArgumentDate::query	public	function	Set up the query for this argument. Overrides SearchApiViewsHandlerArgument::query
SearchApiViewsHandlerArgumentDate::title	public	function	Computes 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::$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::admin_summary	public	function	Provide text for the administrative summary.	4
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::construct	public	function	Views handlers use a special construct function. Overrides views_object::construct	5
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_argument_form	public	function	Provide a form for selecting the default argument.	1
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_plugin	public	function	Generic plugin export handler.	1
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_default_argument	public	function	Get a default argument, if available.	1
views_handler_argument::get_plugin	public	function	Get the display or row plugin, if it exists.
views_handler_argument::get_sort_name	public	function	Return a description of how the argument would normally be sorted.	5
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::init	public	function	Init the handler with necessary data. Overrides views_handler::init	3
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::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::options_submit
views_handler_argument::options_validate	public	function	Validate the options form. Overrides views_handler::options_validate
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_argument	public	function	Provide the argument to use to link from the summary to the next level.	4
views_handler_argument::summary_basics	public	function	Some basic summary behavior.
views_handler_argument::summary_name	public	function	Provides the name to use for the summary.	10
views_handler_argument::summary_name_field	public	function	Add the name field, which is the field displayed in summary queries.
views_handler_argument::summary_query	public	function	Build the info for the summary query.	3
views_handler_argument::summary_sort	public	function	Sorts the summary based upon the user's selection.
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_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

You are here

class SearchApiViewsHandlerArgumentDate in Search API 7

Hierarchy

File

Members

API Navigation