class handler_filter_radius in Search API Location 7

Filter radius

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_filter
      • class \handler_filter_radius

1 string reference to 'handler_filter_radius'

search_api_location_views_data in ./search_api_location.module

Implements hook_views_data().

File

includes/handler_filter_radius.inc, line 7

class handler_filter_radius extends views_handler_filter {

  // This is always single, because of the distance field's possible dependency
  // on it.
  var $no_single = TRUE;
  function option_definition() {
    $options = parent::option_definition();
    $options['identifier'] = array(
      'default' => 'dist',
    );
    $options['value'] = array(
      'locpick' => array(
        'latitude' => 0,
        'longitude' => 0,
      ),
      'distance' => array(
        'search_distance' => 40,
      ),
    );
    $options['expose']['contains']['gmap_macro'] = array(
      'default' => '[gmap ]',
    );
    return $options;
  }
  function admin_summary() {
    return '';
  }

  /**
   * Shortcut to display the value form.
   */
  function show_value_form(&$form, &$form_state) {
    $this
      ->value_form($form, $form_state);
    if (empty($this->no_operator)) {
      $form['value']['#prefix'] = '<div class="views-left-70">' . (isset($form['value']['#prefix']) ? $form['value']['#prefix'] : '');
      $form['value']['#suffix'] = (isset($form['value']['#suffix']) ? $form['value']['#suffix'] : '') . '</div>';
    }
  }
  function value_form(&$form, &$form_state) {
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
    }
    $view = $this->view;
    if (isset($view->exposed_input[$identifier])) {
      $exposed_input = $view->exposed_input[$identifier];
    }
    else {
      $exposed_input = $this->value;
    }
    $form['value'] = array(
      '#tree' => TRUE,
    );
    $form['#attributes'] = array(
      'class' => array(
        'search-api-location',
      ),
    );
    $form['value']['locpick'] = array(
      '#type' => 'container',
      '#weight' => 0,
    );
    $form['value']['locpick']['latitude'] = array(
      '#type' => 'textfield',
      '#title' => t('Latitude'),
      '#default_value' => $exposed_input['locpick']['latitude'],
      '#weight' => 0,
    );
    $form['value']['locpick']['longitude'] = array(
      '#type' => 'textfield',
      '#title' => t('Longitude'),
      '#default_value' => $exposed_input['locpick']['longitude'],
      '#weight' => 5,
    );
    $form['value']['distance'] = array(
      '#type' => 'container',
      '#weight' => 10,
    );
    $form['value']['distance']['search_distance'] = array(
      '#type' => 'textfield',
      '#title' => t('Distance, km:'),
      '#default_value' => $exposed_input['distance']['search_distance'],
    );
  }

  /**
   * Validate the options form.
   */
  function value_validate($form, &$form_state) {
    if (isset($form_state['values']['options']['value'])) {
      $values = $form_state['values']['options']['value'];
      if (!is_numeric($values['locpick']['latitude'])) {
        form_set_error('latitude', t('Latitude value must be not empty and numeric'));
      }
      if (!is_numeric($values['locpick']['longitude'])) {
        form_set_error('longitude', t('Longitude value must be not empty and numeric'));
      }
      if (!is_numeric($values['distance']['search_distance']) || $values['distance']['search_distance'] < 0.25) {
        form_set_error('search_distance', t('Distance value must be not empty and greater then 0.25'));
      }
    }
  }
  function exposed_form(&$form, &$form_state) {
    parent::exposed_form($form, $form_state);
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
    }
    $view = $this->view;
    if (isset($view->exposed_input[$identifier])) {
      $exposed_input = $view->exposed_input[$identifier];
    }
    else {
      $exposed_input = $this->value;
    }
    drupal_add_library('system', 'ui.slider');
    drupal_add_js(drupal_get_path('module', 'search_api_location') . '/js/search_api_location.js');
    $form[$identifier]['distance']['search_distance'] += array(
      '#id' => 'search_distance_value',
      '#size' => '10',
      '#weight' => 4,
    );
    $form[$identifier]['distance']['search_distance_slider'] = array(
      '#type' => 'item',
      '#weight' => 5,
      '#suffix' => '<div id="search_distance_slider"></div>',
    );
  }
  function exposed_validate($form, &$form_state) {
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (isset($form_state['values'][$identifier])) {
        $values = $form_state['values'][$identifier];
        if (!is_numeric($values['locpick']['latitude']) || !is_numeric($values['locpick']['longitude'])) {
          form_error($form, t('You need to choose search position.'));
        }
      }
    }
  }
  function query() {
    if (empty($this->value)) {
      return;
    }
    elseif (!isset($this->value[0]['locpick']['latitude']) || empty($this->value[0]['locpick']['latitude']) || !isset($this->value[0]['locpick']['longitude']) || empty($this->value[0]['locpick']['longitude']) || !isset($this->value[0]['distance']['search_distance']) || empty($this->value[0]['distance']['search_distance'])) {
      return;
    }
    $index = search_api_index_load(substr($this->table, 17));
    if (!isset($index) || !is_object($index) || !$index->enabled) {
      return;
    }
    $options = array_merge($this->options, $this->options['value'], $this->value[0]);

    //convering to miles (because localsolr search use only miles)
    $radius = $options['distance']['search_distance'] * 0.621371192237;
    $search_options = array(
      'query_type' => 'geo',
      'lat' => $options['locpick']['latitude'],
      'lng' => $options['locpick']['longitude'],
      'radius' => $radius,
      'sort' => 'asc',
    );
    $query = $this->query
      ->getSearchApiQuery();
    foreach ($search_options as $key => $value) {
      $query
        ->setOption($key, $value);
    }
    $old = $this->query
      ->getOriginalKeys();
    $keys =& $this->query
      ->getKeys();
    if ($old) {
      $keys =& $this->query
        ->getKeys();
      if (is_array($keys)) {
        $keys[] = $old;
      }
      elseif (is_array($old)) {

        // We don't support such nonsense.
      }
      else {
        $keys = "({$old}) ({$keys})";
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
handler_filter_radius::$no_single		property
handler_filter_radius::admin_summary		function	Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary
handler_filter_radius::exposed_form		function	Render our chunk of the exposed filter form when selecting. Overrides views_handler_filter::exposed_form
handler_filter_radius::exposed_validate		function	Validate the exposed handler form. Overrides views_handler::exposed_validate
handler_filter_radius::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition
handler_filter_radius::query		function	Add this filter to the query. Overrides views_handler_filter::query
handler_filter_radius::show_value_form		function	Shortcut to display the value form. Overrides views_handler_filter::show_value_form
handler_filter_radius::value_form		function	Options form subform for setting options. Overrides views_handler_filter::value_form
handler_filter_radius::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_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::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_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::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