class contextual_range_filter_handler_argument_date_range in Views Contextual Range Filter 7

Argument handler for arguments that are date ranges.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_argument
    class \views_handler_argument_formula
    class \views_handler_argument_date
    class \contextual_range_filter_handler_argument_date_range

Expanded class hierarchy of contextual_range_filter_handler_argument_date_range

1 string reference to 'contextual_range_filter_handler_argument_date_range'

contextual_range_filter_views_data_alter in views/contextual_range_filter.views.inc: Implements hook_views_data_alter().

File

views/contextual_range_filter_handler_argument_date_range.inc, line 13: Definition of contextual_filter_range_handler_argument_numeric_range.

View source

class contextual_range_filter_handler_argument_date_range extends views_handler_argument_date {

  /**
   * Constructor implementation.
   */
  public function construct() {
    parent::construct();
  }

  /**
   * Create the option definition.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['relative_dates'] = array(
      'default' => TRUE,
    );
    $options['break_phrase'] = array(
      'default' => FALSE,
    );
    $options['not'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Create the options form.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['description']['#markup'] = t('Contextual date range filter values are taken from the URL.');
    $form['more']['#collapsed'] = FALSE;
    $form['relative_dates'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow relative date ranges'),
      '#description' => t('If ticked, offsets from the current date may be specified.<br/>Example: <strong>2 weeks ago--yesterday"</strong>'),
      '#default_value' => $this->options['relative_dates'],
      '#fieldset' => 'more',
    );

    // Allow passing multiple values (ranges).
    $form['break_phrase'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow multiple date ranges'),
      '#description' => t('If ticked, multiple ranges may be specified by stringing them together with plus signs.<br/>Example: <strong>19990101--20051231+20130701--20140630</strong>'),
      '#default_value' => $this->options['break_phrase'],
      '#fieldset' => 'more',
    );
    $form['not'] = array(
      '#type' => 'checkbox',
      '#title' => t('Exclude'),
      '#description' => t('Negate the range. If selected, output matching the specified date range(s) will be excluded, rather than included.'),
      '#default_value' => !empty($this->options['not']),
      '#fieldset' => 'more',
    );
  }

  /**
   * Title override.
   *
   * Required because of range version of views_break_phrase() in this function.
   */
  public function title() {
    if (!$this->argument) {
      return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
    }
    if (!empty($this->options['break_phrase'])) {
      $this
        ->views_break_phrase_range($this->argument);
    }
    else {
      $this->value = array(
        $this->argument,
      );
      $this->operator = 'or';
    }
    if ($this->value === FALSE) {
      return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : t('Invalid input');
    }
    if (empty($this->value)) {
      return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
    }
    return implode($this->operator == 'or' ? ' + ' : ', ', $this->value);
  }

  /**
   * Prepare the range query WHERE-clause.
   */
  public function query($group_by = FALSE) {
    $this
      ->ensure_my_table();
    if (!empty($this->options['break_phrase'])) {

      // From "Allow multple ranges" checkbox.
      $this
        ->views_break_phrase_range($this->argument);
    }
    else {
      $this->value = array(
        $this->argument,
      );
    }
    $this
      ->set_formula(NULL);
    $range_conversion = empty($this->options['relative_dates']) ? NULL : array(
      $this,
      'convert_relative_date_range',
    );
    contextual_range_filter_build_range_query($this, $this
      ->get_formula(), $range_conversion);
  }

  /**
   * Converts relative date range, "six months ago--now" to absolute date range.
   *
   * The format used for the absolute date range is the one set on this handler.
   *
   * @param string $from, start date of the range
   * @param string $to, end date of the range
   *
   * @return array of 2 strings
   */
  public function convert_relative_date_range($from, $to) {
    $format = $this->arg_format;
    if (!empty($from)) {
      $abs_from = strtotime($from);
      $from = empty($abs_from) ? date($format) : date($format, $abs_from);
    }
    if (!empty($to)) {
      $abs_to = strtotime($to);
      $to = empty($abs_to) ? date($format) : date($format, $abs_to);
    }
    return array(
      $from,
      $to,
    );
  }

  /**
   * Break xfrom--xto+yfrom--yto+zfrom--zto into an array or ranges.
   *
   * @param string $str
   *   The string to parse.
   */
  public function views_break_phrase_range($str) {
    if (empty($str)) {
      return;
    }
    $this->value = preg_split('/[+ ]/', $str);
    $this->operator = 'or';

    // Keep an 'error' value if invalid ranges were given.
    // A single non-empty value is ok, but a plus sign without values is not.
    if (count($this->value) > 1 && (empty($this->value[0]) || empty($this->value[1]))) {

      // Used in $this->title().
      $this->value = FALSE;
    }
  }

  /**
   * Sets the SQL formula to use for this contextual filter handler.
   *
   * @param string $offset
   *    The name of a field that holds the timezone offset or NULL.
   *
   * @see views/modules/node/views_handler_argument_dates_various.inc
   */
  private function set_formula($offset = NULL) {
    $field_type = 'int';
    if (!empty($this->definition['is date'])) {

      // Date module field comes in three flavours.
      // Date (default) is stored on the database like: Y-m-d H:i:s
      // Date (ISO format) is stored like so: Y-m-dTH:i:s (T replaces space)
      // Date (Unix timestamp) is stored as an int, e.g., 1389789000
      $this->arg_format = 'Y-m-d H:i:s';
      $field_info = field_info_field($this->definition['field_name']);
      $field_type = $field_info['type'] == 'datestamp' ? 'int' : 'datetime';
    }
    elseif (isset($this->field)) {

      // Suspect node property. Can only tell heuristically via $this->field...
      switch ($this->field) {
        case 'created_year':
        case 'changed_year':
          $this->arg_format = 'Y';
          $extract_type = 'YEAR';
          break;
        case 'created_year_month':
        case 'changed_year_month':
          $this->format = 'F Y';
          $this->arg_format = 'Ym';
          break;
        case 'created_month':
        case 'changed_month':
          $this->format = 'F';
          $this->arg_format = 'm';
          $extract_type = 'MONTH';
          break;
        case 'created_day':
        case 'changed_day':
          $this->format = 'j';
          $this->arg_format = 'd';
          $extract_type = 'DAY';
          break;
        case 'created_week':
        case 'changed_week':
          $this->arg_format = 'w';
          $extract_type = 'WEEK';
          break;

        // created_fulldate
        // changed_fulldate
        default:
          $this->format = 'F j, Y';
          $this->arg_format = 'Ymd';
      }
    }
    $field = isset($this->real_field) ? $this->real_field : $this->name_field;
    return $this->formula = empty($extract_type) ? views_date_sql_format($this->arg_format, "***table***.{$field}", $field_type, $offset) : views_date_sql_extract($extract_type, "***table***.{$field}", $field_type, $offset);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
contextual_range_filter_handler_argument_date_range::construct	public	function	Constructor implementation. Overrides views_handler_argument_formula::construct
contextual_range_filter_handler_argument_date_range::convert_relative_date_range	public	function	Converts relative date range, "six months ago--now" to absolute date range.
contextual_range_filter_handler_argument_date_range::options_form	public	function	Create the options form. Overrides views_handler_argument::options_form
contextual_range_filter_handler_argument_date_range::option_definition	public	function	Create the option definition. Overrides views_handler_argument::option_definition
contextual_range_filter_handler_argument_date_range::query	public	function	Prepare the range query WHERE-clause. Overrides views_handler_argument_formula::query
contextual_range_filter_handler_argument_date_range::set_formula	private	function	Sets the SQL formula to use for this contextual filter handler.
contextual_range_filter_handler_argument_date_range::title	public	function	Title override. Overrides views_handler_argument::title
contextual_range_filter_handler_argument_date_range::views_break_phrase_range	public	function	Break xfrom--xto+yfrom--yto+zfrom--zto into an array or ranges.
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::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::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::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_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_default_argument	public	function	Set the empty argument value to the current date. Overrides views_handler_argument::get_default_argument
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_handler_argument_formula::summary_query	public	function	Build the summary query based on a formula Overrides views_handler_argument::summary_query
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 contextual_range_filter_handler_argument_date_range in Views Contextual Range Filter 7

Hierarchy

File

Members

API Navigation