You are here

Home » API reference » Geofield 7.2 » geofield_handler_argument_proximity.inc

class geofield_handler_argument_proximity in Geofield 7.2

The proximity argument may be appended to URL in the following format: /lat,lon_dist where dist is a positive number representing a circular proximity in either kilometers or miles, as configured through the contextual filter UI.

Hierarchy

Expanded class hierarchy of geofield_handler_argument_proximity

1 string reference to 'geofield_handler_argument_proximity'
geofield_field_views_data in views/geofield.views.inc
Implements hook_field_views_data().

File

views/handlers/geofield_handler_argument_proximity.inc, line 15
Geofield contextual filter argument handler for Views.

View source 
class geofield_handler_argument_proximity extends views_handler_argument {
  function option_definition() {
    $options = parent::option_definition();
    $options['proximity']['operation'] = array(
      'default' => 'lt',
    );
    $options['proximity']['default_radius'] = array(
      'default' => 100,
    );
    $options['proximity']['radius_unit'] = array(
      'default' => GEOFIELD_KILOMETERS,
    );
    return $options;
  }

  /**
   * Add form elements to select options for this contextual filter.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['proximity'] = array(
      '#type' => 'fieldset',
      '#title' => t('Filter locations by proximity to a reference point'),
      '#description' => t('The reference point is normally apppend to the URL as lat,lon, or if you have the !geocoder module enabled, as a partial address, like "/New York"', array(
        '!geocoder' => l('Geocoder', 'http://drupal.org/project/geocoder'),
      )),
    );
    $form['proximity']['operation'] = array(
      '#type' => 'select',
      '#title' => t('Select locations'),
      '#options' => array(
        'lt' => t('Inside radius'),
        'gt' => t('Outside radius'),
      ),
      '#default_value' => $this->options['proximity']['operation'],
      '#description' => t("Reference point coordinates (<strong>lat,lon</strong>) and <strong>distance</strong> are typically appended to the URL. A fallback may be entered above under <em>Provide default value</em> as either a <em>Fixed value</em> or as <em>PHP Code</em>. <br/>In all cases use this format: <strong>lat,lon distance</strong>. You may omit either <strong>lat,lon</strong> or <strong>distance</strong>. Instead of spaces and comma's, you can use underscores."),
    );
    $form['proximity']['default_radius'] = array(
      '#type' => 'textfield',
      '#title' => t('Default radius'),
      '#size' => 8,
      '#default_value' => $this->options['proximity']['default_radius'],
      '#description' => t("Used if no distance is specified. If left blank <em>Fixed value</em> or <em>PHP Code</em> will be used instead."),
    );
    $form['proximity']['radius_unit'] = array(
      '#type' => 'select',
      '#title' => t('Unit of distance'),
      '#options' => geofield_radius_options(),
      '#default_value' => $this->options['proximity']['radius_unit'],
      '#description' => t('Select the unit of distance.'),
    );
  }

  /**
   * Set up the where clause for the contextual filter argument.
   */
  function query($group_by = FALSE) {
    $lat_lon_dist = array();
    foreach ($this->view->argument as $argument) {
      if ($argument->field == 'field_geofield_distance') {

        // Get and process args.
        $lat_lon_dist = $this
          ->parseArg($argument);
        break;
      }
    }

    // At this point we expect $lat_lon_dist to contain 3 numeric values.
    if (count($lat_lon_dist) < 3) {
      return;
    }

    // Provide hook_geofield_handler_default_argument_alter(), so args may be
    // altered by other modules.
    drupal_alter('geofield_handler_argument_proximity', $this, $lat_lon_dist);
    $table = $this
      ->ensure_my_table() ? $this->table_alias : $this->table;
    $haversine_args = array(
      'earth_radius' => $this->options['proximity']['radius_unit'],
      'origin_latitude' => $lat_lon_dist['latitude'],
      'origin_longitude' => $lat_lon_dist['longitude'],
      'destination_latitude' => $table . '.' . $this->definition['field_name'] . '_lat',
      'destination_longitude' => $table . '.' . $this->definition['field_name'] . '_lon',
    );
    $formula = geofield_haversine($haversine_args);
    $operator = $this->options['proximity']['operation'] == 'gt' ? '>' : '<';
    $where = $formula . $operator . $lat_lon_dist['distance'];
    $this->query
      ->add_where_expression(0, $where);
  }
  function parseArg($argument) {

    // Get and process args. Expect and parse this format: "lat,lon dist".
    if (!empty($this->view->args) && ($lat_lon_dist = $this
      ->parseLatLonDistArg($this->view->args[$argument->position]))) {

      // Found lat, lon and dist. Can proceed with haversine formula.
      return $lat_lon_dist;
    }

    // The filter argument cannot be parsed as a lat,lon_dist string.
    // Reinterpret this and all trailing arguments as an address of sorts.
    // Examples:
    // "/Sydney/Opera House" or "/sydney opera house"
    // "/Portland" (defaults to "/Portland, Oregon")
    // "/Indiana/Portland" or "/IN/Portland"  or "/Portland IN"
    // Ignore all args up to the one that belongs to this contextual filter.
    $args = array_slice(arg(), $argument->position + 1);
    return $this
      ->parseAddress($args);

    // may return FALSE
  }

  /**
   * Extract lat,lon and distance from arg and return as array.
   *
   * @param type $arg_string
   * @return array(lat, lon, dist) or FALSE if string could not be parsed.
   */
  function parseLatLonDistArg($arg_string) {
    $args = array_filter(preg_split(GEOFIELD_PROXIMITY_REGEXP_PATTERN, $arg_string));
    foreach ($args as $value) {
      if (!is_numeric($value)) {
        return FALSE;
      }
    }
    if (count($args) == 3) {

      // Got lat + lon + dist: we're good to go
      // Use next() on $args as after array_filter() we cannot be sure what
      // the element indices are.
      return array(
        'latitude' => reset($args),
        'longitude' => next($args),
        'distance' => next($args),
      );
    }

    // Either distance or lat,lon where omitted. See if we can get these
    // from the defaults.
    $lat = reset($args);
    $lon = next($args);
    if ($lat !== FALSE && $lon !== FALSE) {

      // 2 args received, interpret as lat,lon and take distrance from default
      if ($dist = $this
        ->getDefaultDist()) {
        return array(
          'latitude' => $lat,
          'longitude' => $lon,
          'distance' => $dist,
        );
      }
      return FALSE;
    }
    if ($lat !== FALSE && $lon === FALSE) {

      // 1 arg received, interpret as distance and take lat,lon from default
      $dist = $lat;
      $defaults = $this
        ->getDefaultLatLonDist();
      if (count($defaults) < 2) {
        return FALSE;
      }
      return array(
        'latitude' => reset($defaults),
        'longitude' => next($defaults),
        'distance' => $dist,
      );
    }

    // If we get here, we're dealing with rubbish
    return FALSE;
  }

  /**
   * Interpret URL args as an address with optional distance attached.
   *
   * Return latitude, longitude and distance as an array.
   *
   * @param array of arguments, e.g. result of arg()
   * @return array(lat, lon, dist) or FALSE if arguments could not be parsed.
   */
  private function parseAddress($args) {
    if (empty($args)) {
      return FALSE;
    }

    // Interpret the last arg as a distance, if it is numeric.
    $dist = is_numeric(end($args)) ? array_pop($args) : $this
      ->getDefaultDist();
    $address = implode(', ', $args);
    if (!empty($address) && module_exists('geocoder')) {
      $all_geocoder_engines = array_keys(geocoder_handler_info('text'));

      // Pick Google if defined, otherwise the first in the list.
      $geocoder_engine = in_array('google', $all_geocoder_engines) ? 'google' : reset($all_geocoder_engines);
      if ($geocoded_data = geocoder($geocoder_engine, $address)) {
        return array(
          'latitude' => $geocoded_data
            ->getY(),
          'longitude' => $geocoded_data
            ->getX(),
          'distance' => $dist,
        );
      }
    }
    return FALSE;
  }
  private function getDefaultLatLonDist() {
    $default_arg = $this
      ->get_default_argument();
    return $default_arg ? array_filter(preg_split(GEOFIELD_PROXIMITY_REGEXP_PATTERN, $default_arg)) : array();
  }
  public function getDefaultDist() {
    if (!empty($this->options['proximity']['default_radius'])) {
      return $this->options['proximity']['default_radius'];
    }
    $defaults = $this
      ->getDefaultLatLonDist();
    if (empty($defaults) || count($defaults) == 2) {

      // expecting either 1 or 3 numbers
      return 100;

      // last resort default, same as geofield_handler_filter.inc
    }
    return isset($defaults[2]) ? $defaults[2] : reset($defaults);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
geofield_handler_argument_proximity::getDefaultDist public function
geofield_handler_argument_proximity::getDefaultLatLonDist private function
geofield_handler_argument_proximity::options_form function Add form elements to select options for this contextual filter. Overrides views_handler_argument::options_form
geofield_handler_argument_proximity::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_argument::option_definition
geofield_handler_argument_proximity::parseAddress private function Interpret URL args as an address with optional distance attached.
geofield_handler_argument_proximity::parseArg function
geofield_handler_argument_proximity::parseLatLonDistArg function Extract lat,lon and distance from arg and return as array.
geofield_handler_argument_proximity::query function Set up the where clause for the contextual filter argument. Overrides views_handler_argument::query
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::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_actions public function List of default behaviors for this argument if the argument is not present. 4
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::title public function Get the title this argument will assign the view, given the argument. 13
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_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