You are here

Home » API reference » Get Locations 7.2 » getlocations_fields_handler_filter_distance.inc

class getlocations_fields_handler_filter_distance in Get Locations 7.2

Same name and namespace in other branches
  1. 7 modules/getlocations_fields/handlers/getlocations_fields_handler_filter_distance.inc \getlocations_fields_handler_filter_distance

General proximity filter for location latitude/longitude.

Hierarchy

Expanded class hierarchy of getlocations_fields_handler_filter_distance

1 string reference to 'getlocations_fields_handler_filter_distance'
getlocations_fields_views_data in modules/getlocations_fields/views/getlocations_fields.views.inc
Implements hook_views_data().

File

modules/getlocations_fields/handlers/getlocations_fields_handler_filter_distance.inc, line 15
getlocations_fields_handler_filter_distance.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

View source 
class getlocations_fields_handler_filter_distance extends views_handler_filter {

  // This is always multiple, because we can have distance, units etc.
  var $always_multiple = TRUE;
  function option_definition() {
    $options = parent::option_definition();
    $options['operator'] = array(
      'default' => 'mbr',
    );
    $options['identifier'] = array(
      'default' => 'distance',
    );
    $options['group'] = array(
      'default' => '0',
    );
    $options['origin'] = array(
      'default' => 'nid_arg',
    );
    $options['settings']['searchbox_size'] = array(
      'default' => '60',
    );
    $options['settings']['restrict_by_country'] = array(
      'default' => 0,
    );
    $options['settings']['country'] = array(
      'default' => variable_get('site_default_country', ''),
    );
    $options['settings']['display_search_distance'] = array(
      'default' => 1,
    );
    $options['settings']['display_search_units'] = array(
      'default' => 1,
    );
    $options['settings']['geocoder_enable'] = array(
      'default' => 0,
    );
    $options['value'] = array(
      'default' => array(
        'latitude' => '',
        'longitude' => '',
        #        'postal_code' => '',

        #        'country' => '',
        'php_code' => '',
        'nid_arg' => '',
        'nid_loc_field' => 'node',
        'uid_arg' => '',
        'uid_loc_field' => 'user',
        'tid_arg' => '',
        'tid_loc_field' => 'taxonomy_term',
        'cid_arg' => '',
        'cid_loc_field' => 'comment',
        'search_distance' => 100,
        'search_units' => 'km',
        'search_field' => '',
        'gps' => '',
      ),
    );
    $options['expose']['contains']['operator_id'] = array(
      'default' => 'mbr',
    );
    $options['expose']['contains']['search_units'] = array(
      'default' => 'km',
    );
    $options['expose']['contains']['search_distance'] = array(
      'default' => 10,
    );
    $options['expose']['contains']['search_field'] = array(
      'default' => '',
    );
    return $options;
  }
  function admin_summary() {
    if (!empty($this->options['exposed'])) {
      return t('Exposed');
    }
    return '';
  }
  function operator_options() {
    return array(
      'mbr' => t('Proximity (Rectangular)'),
      'dist' => t('Proximity (Circular)'),
    );
  }
  function expose_options() {
    parent::expose_options();
    $this->options['expose']['search_units'] = array(
      'default' => 'km',
    );
    $this->options['expose']['search_distance'] = array(
      'default' => 10,
    );
    $this->options['expose']['search_field'] = array(
      'default' => '',
    );
  }
  function value_form(&$form, &$form_state) {
    parent::value_form($form, $form_state);
    $form['origin'] = getlocations_fields_element_origin($this->options['origin']);
    if (!empty($this->options['exposed'])) {
      $form['settings'] = array(
        '#type' => 'fieldset',
        '#title' => t('Form settings'),
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
        // This will store all the defaults in one variable.
        '#tree' => TRUE,
      );
      $form['settings']['display_search_units'] = getlocations_element_map_checkbox(t('Display Search units dropdown'), isset($this->options['settings']['display_search_units']) ? $this->options['settings']['display_search_units'] : 1, t('Allow users to modify the search units.'));
      $form['settings']['display_search_distance'] = getlocations_element_map_checkbox(t('Display Search distance box'), isset($this->options['settings']['display_search_distance']) ? $this->options['settings']['display_search_distance'] : 1, t('Allow users to modify the search distance.'));

      // Google autocomplete
      $form['settings']['searchbox_size'] = getlocations_element_map_tf(t('Search box size'), isset($this->options['settings']['searchbox_size']) ? $this->options['settings']['searchbox_size'] : 60, t('The width of the search box.'), 5, 5, TRUE);
      $form['settings']['searchbox_size']['#dependency'] = array(
        'edit-options-origin' => array(
          'search',
        ),
      );

      // geocoder type
      $geocoder_default['geocoder_enable'] = isset($this->options['settings']['geocoder_enable']) ? $this->options['settings']['geocoder_enable'] : 0;
      $form['settings'] += getlocations_geocoder_form($geocoder_default);

      // country restriction
      $form['settings']['restrict_by_country'] = getlocations_element_map_checkbox(t('Restrict by country'), isset($this->options['settings']['restrict_by_country']) ? $this->options['settings']['restrict_by_country'] : 0, t('Restrict searches to the country set below. Works with Google Autocomplete.'));
      $form['settings']['restrict_by_country']['#dependency'] = array(
        'edit-options-origin' => array(
          'search',
        ),
      );
      $form['settings']['restrict_by_country']['#suffix'] = '<div id="getlocations_search_country">';
      $countries = getlocations_get_countries_list();
      $form['settings']['country'] = getlocations_element_dd(t('Search country'), isset($this->options['settings']['country']) ? $this->options['settings']['country'] : variable_get('site_default_country', ''), $countries);
      $form['settings']['country']['#dependency'] = array(
        'edit-options-origin' => array(
          'search',
        ),
      );
      $form['settings']['country']['#suffix'] = '</div>';
      $getlocations_fields_paths = getlocations_fields_paths_get();
      $getlocations_paths = getlocations_paths_get();
      $form['#attached']['js'] = array(
        $getlocations_fields_paths['getlocations_fields_search_views_path'] => array(
          'type' => 'file',
          'weight' => 20,
        ),
        $getlocations_paths['getlocations_geo_path'] => array(
          'type' => 'file',
          'weight' => 21,
        ),
      );
      if ($this->options['origin'] == 'search') {
        if (isset($this->options['settings'])) {
          $settings = array(
            'getlocations_fields_search_views' => array(
              'restrict_by_country' => isset($this->options['settings']['restrict_by_country']) ? $this->options['settings']['restrict_by_country'] : 0,
              'country' => isset($this->options['settings']['country']) ? $this->options['settings']['country'] : variable_get('site_default_country', ''),
              'geocoder_enable' => $geocoder_default['geocoder_enable'],
            ),
          );
          drupal_add_js($settings, 'setting');
        }
        $getlocations_defaults = getlocations_defaults();
        $getlocations_defaults['geocoder_enable'] = $geocoder_default['geocoder_enable'];
        getlocations_setup_js($getlocations_defaults, TRUE);
      }
    }
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (!isset($form_state['input'][$identifier])) {

        // We need to pretend the user already inputted the defaults, because
        // fapi will malfunction otherwise.
        $form_state['input'][$identifier] = $this->value;
      }
    }
    $form['value'] = array(
      '#tree' => TRUE,
    );
    if ($this->options['origin'] == 'search') {
      $form['value']['search_field'] = getlocations_element_map_tf(t('Search'), '', '', isset($this->options['settings']['searchbox_size']) && $this->options['settings']['searchbox_size'] ? $this->options['settings']['searchbox_size'] : 60);
      $form['value']['search_field']['#dependency'] = array(
        'edit-options-origin' => array(
          'search',
        ),
      );
      $form['value']['search_field']['#attributes']['title'] = array(
        t('Start typing an address, then select from the dropdown'),
      );
    }
    $form['value']['latitude'] = getlocations_fields_element_latitude($this->value['latitude']);
    $form['value']['longitude'] = getlocations_fields_element_longitude($this->value['longitude']);
    if ($this->options['origin'] == 'search') {
      $form['value']['latitude']['#prefix'] = '<div class="js-hide">';
      $form['value']['longitude']['#suffix'] = '</div>';
    }

    #$form['value']['postal_code'] = getlocations_fields_element_postal_code($this->value['postal_code']);

    #$form['value']['country'] = getlocations_fields_element_country($this->value['country']);
    $form['value']['php_code'] = getlocations_fields_element_php_code($this->value['php_code']);

    // hide something in the DOM so that js knows this is a gps origin
    if ($this->options['origin'] == 'gps') {
      $form['value']['gps'] = array(
        '#type' => 'hidden',
        '#value' => 'origin',
        '#dependency' => array(
          'edit-options-origin' => array(
            'gps',
          ),
        ),
      );
    }
    list($nid_argument_options, $uid_argument_options, $tid_argument_options, $cid_argument_options) = getlocations_fields_views_proximity_get_argument_options($this->view);
    $loc_field_options = getlocations_fields_views_proximity_get_location_field_options();
    if ($nid_argument_options) {
      $form['value']['nid_arg'] = getlocations_fields_element_nid_arg($this->value['nid_arg'], $nid_argument_options);
      $form['value']['nid_loc_field'] = getlocations_fields_element_nid_loc_field($this->value['nid_loc_field'], $loc_field_options);
    }
    if ($uid_argument_options) {
      $form['value']['uid_arg'] = getlocations_fields_element_uid_arg($this->value['uid_arg'], $uid_argument_options);
      $form['value']['uid_loc_field'] = getlocations_fields_element_uid_loc_field($this->value['uid_loc_field'], $loc_field_options);
    }
    if ($tid_argument_options) {
      $form['value']['tid_arg'] = getlocations_fields_element_tid_arg($this->value['tid_arg'], $tid_argument_options);
      $form['value']['tid_loc_field'] = getlocations_fields_element_tid_loc_field($this->value['tid_loc_field'], $loc_field_options);
    }

    ## not tested yet
    if ($cid_argument_options) {
      $form['value']['cid_arg'] = getlocations_fields_element_cid_arg($this->value['cid_arg'], $cid_argument_options);
      $form['value']['cid_loc_field'] = getlocations_fields_element_cid_loc_field($this->value['cid_loc_field'], $loc_field_options);
    }
    $form['value']['search_units'] = getlocations_element_distance_unit($this->value['search_units']);
    $form['value']['search_distance'] = getlocations_element_search_distance($this->value['search_distance']);
    $form['value']['search_operator'] = array(
      '#type' => 'hidden',
      '#value' => $this->options['operator'],
      '#attributes' => array(
        'id' => array(
          'views_search_operator',
        ),
      ),
    );
  }
  function exposed_form(&$form, &$form_state) {
    parent::exposed_form($form, $form_state);
    $key = $this->options['expose']['identifier'];
    $origin = $this->options['origin'];

    // Strip dependencies off on exposed form.
    foreach (element_children($form[$key]) as $el) {
      if (!empty($form[$key][$el]['#dependency'])) {
        $form[$key][$el]['#dependency'] = array();
      }
    }

    // unset anything not needed on exposed form
    if ($origin != 'search') {
      unset($form[$key]['latitude']);
      unset($form[$key]['longitude']);
    }
    unset($form[$key]['php_code']);
    unset($form[$key]['nid_arg']);
    unset($form[$key]['nid_loc_field']);
    unset($form[$key]['uid_arg']);
    unset($form[$key]['uid_loc_field']);
    unset($form[$key]['tid_arg']);
    unset($form[$key]['tid_loc_field']);
    unset($form[$key]['cid_arg']);
    unset($form[$key]['cid_loc_field']);
    unset($form['origin']);
    if (isset($this->options['settings']['display_search_distance'])) {
      if (!$this->options['settings']['display_search_distance']) {
        $def = $form[$key]['search_distance']['#default_value'];
        unset($form[$key]['search_distance']);
        $form[$key]['search_distance'] = array(
          '#type' => 'value',
          '#value' => $def,
        );
      }
      else {
        if (!$this->options['settings']['display_search_units']) {
          $def = $form[$key]['search_units']['#default_value'];
          $form[$key]['search_distance']['#field_suffix'] = getlocations_get_unit_names($def, 'plurals');
        }
      }
    }
    if (isset($this->options['settings']['display_search_units'])) {
      if (!$this->options['settings']['display_search_units']) {
        $def = $form[$key]['search_units']['#default_value'];
        unset($form[$key]['search_units']);
        $form[$key]['search_units'] = array(
          '#type' => 'value',
          '#value' => $def,
        );
      }
    }
    unset($form['settings']);
  }
  function query() {
    if (empty($this->value)) {
      return;
    }

    // We need to merge with $this->options['value'] for filter values
    // and $this->value for exposed filter values.
    $options = array_merge($this->options, $this->options['value'], $this->value);
    $coordinates = getlocations_fields_views_proximity_get_reference_location($this->view, $options);

    // If we don't have any coordinates or distance, there's nothing to filter by, so don't modify the query at all.
    if (empty($coordinates) || !$coordinates['latitude'] || !$coordinates['longitude'] || empty($this->value['search_distance'])) {
      return;
    }
    $this
      ->ensure_my_table();
    $lat = $coordinates['latitude'];
    $lon = $coordinates['longitude'];
    $distance_meters = getlocations_convert_distance_to_meters($this->value['search_distance'], $this->value['search_units']);
    $latrange = getlocations_earth_latitude_range($lat, $lon, $distance_meters);
    $lonrange = getlocations_earth_longitude_range($lat, $lon, $distance_meters);

    // If the table alias is specified, add on the separator.
    $table_alias = empty($this->table_alias) ? '' : $this->table_alias . '.';

    // Add MBR check (always).
    // In case we go past the 180/-180 mark for longitude.
    if ($lonrange[0] > $lonrange[1]) {
      $where = $table_alias . "latitude > :minlat\n      AND " . $table_alias . "latitude < :maxlat\n      AND ((" . $table_alias . "longitude < 180\n      AND " . $table_alias . "longitude > :minlon)\n      OR (" . $table_alias . "longitude < :maxlon\n      AND " . $table_alias . "longitude > -180))";
    }
    else {
      $where = $table_alias . "latitude > :minlat\n      AND " . $table_alias . "latitude < :maxlat\n      AND " . $table_alias . "longitude > :minlon\n      AND " . $table_alias . "longitude < :maxlon";
    }
    $this->query
      ->add_where_expression($this->options['group'], $where, array(
      ':minlat' => $latrange[0],
      ':maxlat' => $latrange[1],
      ':minlon' => $lonrange[0],
      ':maxlon' => $lonrange[1],
    ));
    if ($this->operator == 'dist') {

      // Add radius check.
      $this->query
        ->add_where_expression($this->options['group'], getlocations_earth_distance_sql($lat, $lon, $this->table_alias) . ' < :distance', array(
        ':distance' => $distance_meters,
      ));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
getlocations_fields_handler_filter_distance::$always_multiple property Disable the possibility to force a single value. Overrides views_handler_filter::$always_multiple
getlocations_fields_handler_filter_distance::admin_summary function Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary
getlocations_fields_handler_filter_distance::exposed_form function Render our chunk of the exposed filter form when selecting. Overrides views_handler_filter::exposed_form
getlocations_fields_handler_filter_distance::expose_options function Provide default options for exposed filters. Overrides views_handler_filter::expose_options
getlocations_fields_handler_filter_distance::operator_options function Provide a list of options for the default operator form. Overrides views_handler_filter::operator_options
getlocations_fields_handler_filter_distance::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition
getlocations_fields_handler_filter_distance::query function Add this filter to the query. Overrides views_handler_filter::query
getlocations_fields_handler_filter_distance::value_form function Options form subform for setting options. Overrides views_handler_filter::value_form
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::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::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_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
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::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_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 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_form public function Shortcut to display the exposed options form.
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_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::$operator public property Contains the operator which is used on the query.
views_handler_filter::$value public property Contains the actual value of the field.
views_handler_filter::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form public function Options form subform for setting the operator. 6
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler::options_form 4
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter::value_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter::value_validate public function Validate the options form. 3
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