You are here

Home » API reference » Search API Location 7.2 » handler_field_location.inc

class SearchApiViewsHandlerFieldLocation in Search API Location 7.2

Specialized handler for latitude/longitude fields.

Hierarchy

Expanded class hierarchy of SearchApiViewsHandlerFieldLocation

1 string reference to 'SearchApiViewsHandlerFieldLocation'
search_api_location_views_views_data_alter in search_api_location_views/search_api_location_views.views.inc
Implements hook_views_data_alter().

File

search_api_location_views/handler_field_location.inc, line 11
Contains SearchApiViewsHandlerFieldLocation.

View source 
class SearchApiViewsHandlerFieldLocation extends entity_views_handler_field_text {

  /**
   * The search query constructed and executed by the current view.
   *
   * @var SearchApiViewsQuery
   */
  public $query;

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['show_distance_to_point'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['conversion_factor'] = array(
      'default' => 1,
    );
    $options['set_precision'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['precision'] = array(
      'default' => 0,
    );
    $options['decimal'] = array(
      'default' => '.',
      'translatable' => TRUE,
    );
    $options['separator'] = array(
      'default' => ',',
      'translatable' => TRUE,
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['show_distance_to_point'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show distance instead of coordinates'),
      '#default_value' => $this->options['show_distance_to_point'],
      '#description' => t('Shows the distance to the point from the filters instead of the coordinates of the result.'),
    );
    $form['conversion_factor'] = array(
      '#type' => 'select',
      '#title' => t('Distance unit'),
      '#default_value' => $this->options['conversion_factor'],
      '#options' => array(
        t('SI') => array(
          '1' => t('Kilometre'),
          '0.001' => t('Metre'),
          '0.0001' => t('Decimetre'),
        ),
        t('Imperial / US') => array(
          '1.60926939169617' => t('Mile'),
          '0.0050301810865191' => t('Pole / rod / perch'),
          '0.0009140767824497258' => t('Yard'),
          '0.0003047851264858275' => t('Foot'),
        ),
        t('Nautic') => array(
          '1.853224610822832' => t('US / British nautical mile'),
          '1.851851851851852' => t('International nautical mile'),
        ),
      ),
      '#dependency' => array(
        'edit-options-show-distance-to-point' => array(
          TRUE,
        ),
      ),
    );
    $form['set_precision'] = array(
      '#type' => 'checkbox',
      '#title' => t('Round'),
      '#description' => t('If checked, the number will be rounded.'),
      '#default_value' => $this->options['set_precision'],
      '#dependency' => array(
        'edit-options-show-distance-to-point' => array(
          TRUE,
        ),
      ),
    );
    $form['precision'] = array(
      '#type' => 'textfield',
      '#title' => t('Precision'),
      '#default_value' => $this->options['precision'],
      '#description' => t('Specify how many digits to print after the decimal point.'),
      '#size' => 2,
      '#maxlength' => 1,
      '#dependency' => array(
        'edit-options-set-precision' => array(
          TRUE,
        ),
      ),
    );
    $form['decimal'] = array(
      '#type' => 'textfield',
      '#title' => t('Decimal point'),
      '#default_value' => $this->options['decimal'],
      '#description' => t('What single character to use as a decimal point.'),
      '#size' => 2,
      '#maxlength' => 1,
      '#dependency' => array(
        'edit-options-show-distance-to-point' => array(
          TRUE,
        ),
      ),
    );
    $form['separator'] = array(
      '#type' => 'textfield',
      '#title' => t('Thousands marker'),
      '#default_value' => $this->options['separator'],
      '#description' => t('What single character to use as the thousands separator.'),
      '#size' => 2,
      '#maxlength' => 1,
      '#dependency' => array(
        'edit-options-show-distance-to-point' => array(
          TRUE,
        ),
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function query() {

    // If the distance has to be displayed add the flag to the spatial settings
    // of this field.
    if (!empty($this->options['show_distance_to_point'])) {
      $spatials = (array) $this->query
        ->getOption('search_api_location', array());
      foreach ($spatials as $i => $spatial) {
        if ($spatial['field'] === $this->real_field) {
          $spatials[$i]['distance'] = TRUE;
        }
      }
      $this->query
        ->setOption('search_api_location', $spatials);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function get_value($values, $field = NULL) {
    if ($field || empty($this->options['show_distance_to_point'])) {

      // Return the normal field value.
      return parent::get_value($values, $field);
    }

    // Return the distance.
    $spatials = (array) $this->query
      ->getOption('search_api_location', array());

    // If the spatial information aren't complete to have a distance skip
    // value fetching.
    foreach ($spatials as $spatial) {
      if ($spatial['field'] === $this->real_field) {
        $spatial_filter = $spatial;
        break;
      }
    }
    if (!isset($spatial_filter)) {
      return NULL;
    }
    $id = $values->_entity_properties['search_api_id'];
    $results = $this->query
      ->getSearchApiResults();
    if (isset($results['search_api_location'][$this->real_field][$id]['distance'])) {
      $value = $results['search_api_location'][$this->real_field][$id]['distance'];
    }
    else {

      // If the server wasn't able to calculate the distance do it here.
      $value = NULL;
      $latlon = parent::get_value($values);
      if (is_string($latlon) && strpos($latlon, ',')) {
        $location = array_combine(array(
          'lat',
          'lon',
        ), explode(',', $latlon, 2));
        $value = search_api_location_calculate_distance($location, array(
          'lat' => $spatial_filter['lat'],
          'lon' => $spatial_filter['lon'],
        ));
      }
    }

    // Do the conversion.
    if (is_numeric($value)) {
      return $value / $this->options['conversion_factor'];
    }
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function render($values) {

    // Render normally.
    if (empty($this->options['show_distance_to_point'])) {
      return parent::render($values);
    }

    // Render as distance.
    $value = $this
      ->get_value($values);
    if (is_numeric($value)) {
      if (!empty($this->options['set_precision'])) {
        $value = number_format($value, $this->options['precision'], $this->options['decimal'], $this->options['separator']);
      }
      else {
        $remainder = abs($value) - intval(abs($value));
        $value = $value > 0 ? floor($value) : ceil($value);
        $value = number_format($value, 0, '', $this->options['separator']);
        if ($remainder) {
          $value .= $this->options['decimal'] . substr($remainder, 2);
        }
      }
      return $this
        ->sanitize_value($value);
    }
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
entity_views_handler_field_text::$current_value public property Stores the current value when rendering list fields.
entity_views_handler_field_text::$entity_type public property Stores the entity type of the result entities.
entity_views_handler_field_text::$wrappers public property Stores the result entities' metadata wrappers.
entity_views_handler_field_text::click_sort public function Adds a click-sort to the query. Overrides views_handler_field::click_sort
entity_views_handler_field_text::pre_render public function Load the entities for all rows that are about to be displayed. Overrides views_handler_field::pre_render
entity_views_handler_field_text::render_single_value public function Render a single field value.
SearchApiViewsHandlerFieldLocation::$query public property The search query constructed and executed by the current view. Overrides views_handler::$query
SearchApiViewsHandlerFieldLocation::get_value public function Overridden to use a metadata wrapper. Overrides entity_views_handler_field_text::get_value
SearchApiViewsHandlerFieldLocation::options_form public function Provide a options form for this handler. Overrides entity_views_handler_field_text::options_form
SearchApiViewsHandlerFieldLocation::option_definition public function Provide options for this handler. Overrides entity_views_handler_field_text::option_definition
SearchApiViewsHandlerFieldLocation::query public function Overridden to add the field for the entity ID (if necessary). Overrides entity_views_handler_field_text::query
SearchApiViewsHandlerFieldLocation::render public function Render the field. Overrides entity_views_handler_field_text::render
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
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::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::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_validate public function Validate the options form. 4
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::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_field::$additional_fields public property Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases public property
views_handler_field::$field_alias public property
views_handler_field::$last_render_index protected property Keeps track of the last render index.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler_field::add_additional_fields public function Add 'additional' fields to the query.
views_handler_field::add_self_tokens public function Add any special tokens this field might use for itself. 4
views_handler_field::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::allow_advanced_render public function Determine if this field can allow advanced rendering. 1
views_handler_field::click_sortable public function Determine if this field is click sortable. 1
views_handler_field::construct public function Construct a new field handler. Overrides views_object::construct 17
views_handler_field::document_self_tokens public function Document any special tokens this field might use for itself. 4
views_handler_field::element_classes public function Return the class of the field.
views_handler_field::element_label_classes public function Return the class of the field's label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type public function Return an HTML element based upon the field's element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field's wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements public function Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens public function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive public function Recursive function to add replacements for nested query string parameters.
views_handler_field::init public function Init the handler with necessary data. Overrides views_handler::init 11
views_handler_field::is_value_empty public function Checks if a field value is empty.
views_handler_field::label public function Get this field's label.
views_handler_field::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit 1
views_handler_field::render_altered public function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link public function Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text public function Perform an advanced text render for the item.
views_handler_field::render_trim_text public function Trim the field down to the specified length.
views_handler_field::theme public function Call out to the theme() function.
views_handler_field::theme_functions public function Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value public function Replace a value with tokens from the last field.
views_handler_field::ui_name public function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name 1
views_handler_field::use_string_group_by public function Determines if this field will be available as an option to group the result by in the style settings.
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