You are here

Home » API reference » Geolocation Proximity 7.2 » geolocation_proximity_views_handler_filter_distance.inc

class geolocation_proximity_views_handler_filter_distance in Geolocation Proximity 7.2

General proximity filter for location latitude/longitude.

Hierarchy

Expanded class hierarchy of geolocation_proximity_views_handler_filter_distance

2 string references to 'geolocation_proximity_views_handler_filter_distance'
geolocation_proximity_field_views_data_alter in ./geolocation_proximity.views.inc
Implements hook_field_views_data_alter()
geolocation_proximity_views_data_alter in ./geolocation_proximity.views.inc
Implements hook_views_data_alter()

File

handlers/geolocation_proximity_views_handler_filter_distance.inc, line 10
Definition of geolocation_proximity_views_handler_filter_distance.

View source 
class geolocation_proximity_views_handler_filter_distance extends views_handler_filter {

  /**
   * init the handler with necessary data.
   */
  function init(&$view, &$options) {
    parent::init($view, $options);
    $this->field_alias = $this->options['id'] . '_filter';
  }

  /**
   * views_handler_filter::option_definition
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['operator'] = array(
      'default' => '<',
    );
    $options['value']['default'] = array(
      'latitude' => NULL,
      'longitude' => NULL,
      'search_distance' => 100,
      'search_units' => 'kilometers',
    );
    return $options;
  }

  /**
   * Display the filter on the administrative summary
   */
  function admin_summary() {
    return FALSE;
  }

  /**
   * Shortcut to display the value form.
   */
  function value_form(&$form, &$form_state) {
    $form['value'] = array(
      '#tree' => TRUE,
    );
    $input_type = !empty($this->value['type']) ? $this->value['type'] : 'direct_input';
    if (empty($form_state['exposed'])) {
      if (module_exists('geolocation_googlemaps') && $this->options['exposed']) {
        $form['value']['type'] = array(
          '#type' => 'radios',
          '#title' => t('Input type'),
          '#options' => array(
            'direct_input' => t('Direct input of latitude, longitude and distance.'),
            'googlemap' => t('Geolocation Googlemaps enhanced widget.'),
          ),
          '#default_value' => $input_type,
        );
      }
      else {
        $form['value']['type'] = array(
          '#type' => 'value',
          '#value' => 'direct_input',
        );
      }
    }
    if (empty($form_state['exposed']) || !empty($form_state['exposed']) && $input_type == 'direct_input') {
      $form['value']['latitude'] = array(
        '#type' => 'textfield',
        '#title' => t('Latitude'),
        '#default_value' => $this->value['latitude'],
      );
      $form['value']['longitude'] = array(
        '#type' => 'textfield',
        '#title' => t('Longitude'),
        '#default_value' => $this->value['longitude'],
      );
    }
    if (!empty($form_state['exposed']) && $input_type == 'googlemap') {
      if (empty($this->view->live_preview)) {
        $id = $form_state['view']->name . '-' . $form_state['view']->current_display;
        $form['value']['googlemap'] = array(
          '#type' => 'container',
          '#attributes' => array(
            'class' => array(
              'field-widget-geolocation-googlemap',
            ),
          ),
        );
        $form['value']['googlemap']['address'] = array(
          '#type' => 'item',
          '#title' => t('Location'),
          '#prefix' => '<div id="geolocation-address-' . $id . '" class="geolocation-address">',
          '#suffix' => '</div>',
          '#required' => FALSE,
        );
        $form['value']['googlemap']['address']['field'] = array(
          '#type' => 'textfield',
          '#maxlength' => 120,
        );
        $form['value']['googlemap']['address']['geocode'] = array(
          '#prefix' => '<span id="geolocation-address-geocode-' . $id . '" class="geolocation-address-geocode">',
          '#suffix' => '</span>',
          '#markup' => t('Get location'),
        );
        $form['value']['googlemap']['help'] = array(
          '#prefix' => '<div id="geolocation-help-' . $id . '" class="geolocation-help">',
          '#suffix' => '</div>',
          '#markup' => t('Enter an address / location in the textfield or click on the map to set a marker'),
        );
        $form['value']['googlemap']['googlemap'] = array(
          '#prefix' => '<div id="geolocation-map-' . $id . '" class="geolocation-map">',
          '#suffix' => '</div>',
        );

        // Presentational item.
        $form['value']['googlemap']['latitem'] = array(
          '#type' => 'item',
          '#title' => t('Latitude:'),
          '#prefix' => '<div id="geolocation-lat-item-' . $id . '" class="geolocation-lat-item">',
          '#suffix' => '</div>',
          '#markup' => '<span class="geolocation-lat-item-value">' . $this->value['latitude'] . '</span>',
          '#required' => FALSE,
        );
        $form['value']['googlemap']['lat'] = array(
          '#type' => 'hidden',
          '#prefix' => '<div id="geolocation-lat-' . $id . '" class="geolocation-lat">',
          '#suffix' => '</div>',
          '#default_value' => $this->value['latitude'],
        );

        // Presentational item.
        $form['value']['googlemap']['lngitem'] = array(
          '#type' => 'item',
          '#title' => t('Longitude:'),
          '#prefix' => '<div id="geolocation-lng-item-' . $id . '" class="geolocation-lng-item">',
          '#suffix' => '</div>',
          '#markup' => '<span class="geolocation-lat-item-value">' . $this->value['longitude'] . '</span>',
          '#required' => FALSE,
        );
        $form['value']['googlemap']['lng'] = array(
          '#type' => 'hidden',
          '#prefix' => '<div id="geolocation-lng-' . $id . '" class="geolocation-lng">',
          '#suffix' => '</div>',
          '#default_value' => $this->value['longitude'],
        );
        $form['value']['googlemap']['remove'] = array(
          '#prefix' => '<div id="geolocation-remove-' . $id . '" class="geolocation-remove"><span>',
          '#suffix' => '</span></div>',
          '#markup' => t('Remove'),
        );

        // Attach CSS and JS files via FAPI '#attached'.
        $form['value']['googlemap']['googlemap']['#attached']['css'][] = drupal_get_path('module', 'geolocation_googlemaps') . '/geolocation_googlemaps.css';
        $form['value']['googlemap']['googlemap']['#attached']['js'][] = array(
          'data' => '//maps.google.com/maps/api/js?sensor=false',
          'type' => 'external',
        );
        $form['value']['googlemap']['googlemap']['#attached']['js'][] = array(
          'data' => '//www.google.com/jsapi',
          'type' => 'external',
        );
        $form['value']['googlemap']['googlemap']['#attached']['js'][] = array(
          'data' => drupal_get_path('module', 'geolocation_googlemaps') . '/geolocation_googlemaps_widget.js',
          'type' => 'file',
          'scope' => 'footer',
        );

        // Make defaults available as javascript settings. In JS files use:
        // Drupal.settings.mapDefaults.lat
        $map_defaults = array(
          $id => array(
            'lat' => $this->value['latitude'],
            'lng' => $this->value['longitude'],
          ),
        );
        $data = array(
          'defaults' => $map_defaults,
          'settings' => array(
            'marker_draggable' => TRUE,
            'scrollwheel' => FALSE,
          ),
        );
        $form['value']['googlemap']['googlemap']['#attached']['js'][] = array(
          'data' => array(
            'geolocation' => $data,
          ),
          'type' => 'setting',
        );
      }
      else {
        $form['value']['googlemap'] = array(
          '#markup' => t('Geolocation proximity Googlemaps exposed filter is not compatible with live preview.'),
        );
        $form['value']['latitude'] = $form['value']['longitude'] = array(
          '#type' => 'value',
          '#value' => "",
        );
      }
    }
    $form['value']['search_distance'] = array(
      '#type' => 'textfield',
      '#title' => t('Max distance (km)'),
      '#default_value' => $this->value['search_distance'],
      '#required' => TRUE,
    );
  }

  /**
   * Validate the options form.
   */
  function value_validate($form, &$form_state) {
    $this
      ->latlng_validate($form['value'], $form_state['values']['options']['value']);
  }
  function exposed_validate(&$form, &$form_state) {
    $this
      ->latlng_validate($form[$this->options['id']], $form_state['values'][$this->options['id']]);
  }

  /**
   * Validate the latitude and longitude values
   */
  function latlng_validate(&$elements, &$values) {
    if (!empty($values['googlemap'])) {
      $values['latitude'] = $values['googlemap']['lat'];
      $values['longitude'] = $values['googlemap']['lng'];
    }
    if ($values['latitude'] !== "") {
      switch (TRUE) {
        case !is_numeric($values['latitude']):
          form_error($elements['latitude'], t('Invalid Latitude. Value must be numeric.'));
          break;
        case $values['latitude'] > 90:
        case $values['latitude'] < -90:
          form_error($elements['latitude'], t('Invalid Latitude. Value must be between 90 and -90.'));
          break;
      }
    }
    if ($values['longitude'] !== "") {
      switch (TRUE) {
        case !is_numeric($values['longitude']):
          form_error($elements['longitude'], t('Invalid Longitude. Value must be numeric.'));
          break;
        case $values['longitude'] > 180:
        case $values['longitude'] < -180:
          form_error($elements['longitude'], t('Invalid Longitude. Value must be between 180 and -180.'));
          break;
      }
    }
    if (!is_numeric($values['search_distance']) || $values['search_distance'] < 0) {
      form_error($elements['search_distance'], t('Invalid Distance. Value must be a positive number.'));
    }
  }

  /**
   * Add this filter to the query.
   */
  function query() {
    if (empty($this->value)) {
      return;
    }
    $value = isset($this->value[0]) ? $this->value[0] : $this->value;
    if ($value['latitude'] === "" || $value['longitude'] === "") {
      return;
    }
    $this
      ->ensure_my_table();
    $table = $this->table_alias;
    $field_id = str_replace('_distance', '', $this->options['field']);

    // Prepare filter values.
    $filter_distance = $value['search_distance'];
    $filter_lat = $value['latitude'];
    $filter_lng = $value['longitude'];

    // Prepare field values.
    $field_latsin = "{$table}.{$field_id}_lat_sin";
    $field_latcos = "{$table}.{$field_id}_lat_cos";
    $field_lng = "{$table}.{$field_id}_lng_rad";

    // Build the query.
    $sql = _proximity_sql_fragment($filter_lat, $filter_lng, $field_latsin, $field_latcos, $field_lng);

    // We use having to be able to reuse the query on field handlers
    $this->query
      ->add_field(NULL, $sql, $this->field_alias);
    $this->query
      ->add_having_expression($this->options['group'], '(' . $this->field_alias . ' IS NULL) OR (' . $this->field_alias . $this->operator . $filter_distance . ')');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
geolocation_proximity_views_handler_filter_distance::admin_summary function Display the filter on the administrative summary Overrides views_handler_filter::admin_summary
geolocation_proximity_views_handler_filter_distance::exposed_validate function Validate the exposed handler form. Overrides views_handler::exposed_validate
geolocation_proximity_views_handler_filter_distance::init function init the handler with necessary data. Overrides views_handler_filter::init
geolocation_proximity_views_handler_filter_distance::latlng_validate function Validate the latitude and longitude values
geolocation_proximity_views_handler_filter_distance::option_definition function views_handler_filter::option_definition Overrides views_handler_filter::option_definition
geolocation_proximity_views_handler_filter_distance::query function Add this filter to the query. Overrides views_handler_filter::query
geolocation_proximity_views_handler_filter_distance::value_form function Shortcut to display the value form. Overrides views_handler_filter::value_form
geolocation_proximity_views_handler_filter_distance::value_validate function Validate the options form. Overrides views_handler_filter::value_validate
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::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_multiple public property Disable the possibility to force a single value. 6
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_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
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_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 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::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_options public function Provide a list of options for the default operator form. 4
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_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