class global_filter_plugin_argument_default_global_filter_proximity in Views Global Filter 7

Default argument plugin to extract the global View filter proximity value set for this contextual filter.

The value returned is a string of the format "lat,lon_dist", which is accepted by the Location and Geofield contextual filters for proximity.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \global_filter_plugin_argument_default_global_filter_proximity

1 string reference to 'global_filter_plugin_argument_default_global_filter_proximity'

global_filter_views_plugins in views/global_filter.views.inc

Implements hook_views_plugins().

File

views/global_filter_plugin_argument_default_global_filter_proximity.inc, line 16

global_filter_plugin_argument_default_global_filter_proximity.inc

class global_filter_plugin_argument_default_global_filter_proximity extends views_plugin_argument_default {

  /**
   * Option definition.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['global_filter_proximity_distance'] = array(
      'default' => '100',
    );
    return $options;
  }

  /**
   * Build the options form.
   */
  public function options_form(&$form, &$form_state) {
    $form['global_filter_proximity_distance'] = array(
      '#type' => 'textfield',
      '#title' => t('Distance'),
      '#size' => 8,
      '#default_value' => $this->options['global_filter_proximity_distance'],
      '#description' => t('Enter a default distance to define the proximity area centered on the reference location supplied by the user in the Global Filter block form. For units etc. see the settings at the bottom of this panel.'),
    );
  }

  /**
   * Get argument.
   */
  public function get_argument() {
    $exception_value = $this->argument->options['exception']['value'];
    $proximity_field_name = isset($this->argument->definition['field_name']) ? $this->argument->definition['field_name'] : $this->argument->field;
    if (global_filter_key_by_name($proximity_field_name)) {
      $arg = global_filter_get_session_value($proximity_field_name);
      if (!empty($arg)) {
        if (is_object($arg)) {

          // Return in this format: lat,lon_dist
          $latlon = $arg->latitude . ',' . $arg->longitude;
          $distance = trim(empty($arg->distance) && $arg->distance != 0 ? $this->options['global_filter_proximity_distance'] : $arg->distance);
          return empty($distance) ? $latlon : $latlon . '_' . $distance;
        }
        if (is_array($arg)) {
          $arg = reset($arg);
        }
        $arg = trim($arg);
        if (!empty($arg)) {

          // Allow $arg to contain distance as second arg. If not specified
          // fall back on the admin default.
          // Allowed patterns: lat,lon_dist and postcode_dist
          // Instead of an underscore a space may be used.
          if (strpos($arg, '_')) {

            // This is the Location module native format.
            return $arg;
          }

          // Allow a space as a separator: "lat,lon dist" or "lat, lon dist"
          if (($pos_space = strrpos($arg, ' ')) && drupal_substr($arg, $pos_space - 1, 1) != ',') {
            $arg = drupal_substr($arg, 0, $pos_space) . '_' . drupal_substr($arg, $pos_space + 1);
          }
          else {

            // No distance specified, append the admin default.
            if ($distance = trim($this->options['global_filter_proximity_distance'])) {
              $arg .= '_' . $distance;
            }
          }
          return $arg;
        }
      }
      return $exception_value;
    }
    $view_name = empty($this->view->human_name) ? $this->view->name : $this->view->human_name;
    drupal_set_message(t('The view %view specifies a global filter location proximity field, %name, as its default contextual filter. However there is no associated <strong>Global Filter block</strong> for it. Please configure a global filter <a href="admin/structure/block">here</a> or remove this contextual filter default from the view.', array(
      '%view' => $view_name,
      '%name' => $proximity_field_name,
    )), 'warning', FALSE);
    return $exception_value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
global_filter_plugin_argument_default_global_filter_proximity::get_argument	public	function	Get argument. Overrides views_plugin_argument_default::get_argument
global_filter_plugin_argument_default_global_filter_proximity::options_form	public	function	Build the options form. Overrides views_plugin_argument_default::options_form
global_filter_plugin_argument_default_global_filter_proximity::option_definition	public	function	Option definition. Overrides views_plugin_argument_default::option_definition
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::construct	public	function	Views handlers use a special construct function.	4
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
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::query	public	function	Add anything to the query that we might need to.	7
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_argument_default::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_default::check_access	public	function	If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
views_plugin_argument_default::convert_options	public	function	Convert options from the older style.	3
views_plugin_argument_default::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_default::options_submit	public	function	Provide the default form form for submitting options. Overrides views_plugin::options_submit	1
views_plugin_argument_default::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate