You are here

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

class getlocations_fields_handler_field_distance in Get Locations 7.2

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

@file getlocations_fields_handler_field_distance.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

Distance field handler.

Hierarchy

Expanded class hierarchy of getlocations_fields_handler_field_distance

1 string reference to 'getlocations_fields_handler_field_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_field_distance.inc, line 11
getlocations_fields_handler_field_distance.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

View source 
class getlocations_fields_handler_field_distance extends views_handler_field {
  function option_definition() {
    $options = parent::option_definition();
    $options['origin'] = array(
      'default' => 'nid_arg',
    );
    $options['units'] = array(
      'default' => 'km',
    );
    $options['latitude'] = array(
      'default' => '',
    );
    $options['longitude'] = array(
      'default' => '',
    );

    #    $options['postal_code'] = array('default' => '');

    #    $options['country'] = array('default' => '');
    $options['php_code'] = array(
      'default' => '',
    );
    $options['nid_arg'] = array(
      'default' => '',
    );
    $options['nid_loc_field'] = array(
      'default' => 'node',
    );
    $options['uid_arg'] = array(
      'default' => '',
    );
    $options['uid_loc_field'] = array(
      'default' => 'user',
    );
    $options['tid_arg'] = array(
      'default' => '',
    );
    $options['tid_loc_field'] = array(
      'default' => 'taxonomy_term',
    );
    $options['cid_arg'] = array(
      'default' => '',
    );
    $options['cid_loc_field'] = array(
      'default' => 'comment',
    );
    $options['distance_arg'] = array(
      'default' => '',
    );
    return $options;
  }
  function has_extra_options() {
    return TRUE;
  }
  function extra_options_form(&$form, &$form_state) {
    $form['origin'] = getlocations_fields_element_origin($this->options['origin'], TRUE);
    $form['latitude'] = getlocations_fields_element_latitude($this->options['latitude']);
    $form['longitude'] = getlocations_fields_element_longitude($this->options['longitude']);
    $form['php_code'] = getlocations_fields_element_php_code($this->options['php_code']);
    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['nid_arg'] = getlocations_fields_element_nid_arg($this->options['nid_arg'], $nid_argument_options);
      $form['nid_loc_field'] = getlocations_fields_element_nid_loc_field($this->options['nid_loc_field'], $loc_field_options);
    }
    if ($uid_argument_options) {
      $form['uid_arg'] = getlocations_fields_element_uid_arg($this->options['uid_arg'], $uid_argument_options);
      $form['uid_loc_field'] = getlocations_fields_element_uid_loc_field($this->options['uid_loc_field'], $loc_field_options);
    }

    ### TESTING
    if ($tid_argument_options) {
      $form['tid_arg'] = getlocations_fields_element_tid_arg($this->options['tid_arg'], $tid_argument_options);
      $form['tid_loc_field'] = getlocations_fields_element_tid_loc_field($this->options['tid_loc_field'], $loc_field_options);
    }
    if ($cid_argument_options) {
      $form['cid_arg'] = getlocations_fields_element_cid_arg($this->options['cid_arg'], $cid_argument_options);
      $form['cid_loc_field'] = getlocations_fields_element_cid_loc_field($this->options['cid_loc_field'], $loc_field_options);
    }
    $form['units'] = getlocations_element_distance_unit($this->options['units']);
  }
  function click_sort($order) {
    $location = getlocations_fields_views_proximity_get_reference_location($this->view, $this->options);
    if ($location) {
      $this->query
        ->add_orderby(NULL, getlocations_earth_distance_sql($location['latitude'], $location['longitude'], $this->table_alias), $order, $this->field_alias);
    }
  }
  function render($values) {
    if (empty($values->{$this->field_alias}) || $values->{$this->field_alias} == 'Unknown') {

      // Unset location, empty display.
      return;
    }
    $meters = (double) $values->{$this->field_alias};
    $distance = getlocations_convert_meters_to_distance($meters, $this->options['units']);
    return theme('getlocations_fields_distance', array(
      'distance' => $distance,
      'units' => $this->options['units'],
    ));
  }
  function query() {

    // Google Autocomplete data needs to be transferred to options
    if ($this->options['origin'] == 'search' && isset($this->view->exposed_data['distance']) && $this->view->exposed_data['distance']['latitude'] && $this->view->exposed_data['distance']['longitude']) {
      $this->options['latitude'] = $this->view->exposed_data['distance']['latitude'];
      $this->options['longitude'] = $this->view->exposed_data['distance']['longitude'];

      // not sure about this, it attempts to sync distance units, seems to work.
      $this->options['units'] = $this->view->exposed_data['distance']['search_units'];
    }
    $coordinates = getlocations_fields_views_proximity_get_reference_location($this->view, $this->options);
    $this
      ->ensure_my_table();
    if (!empty($coordinates) && $coordinates['latitude'] && $coordinates['longitude']) {
      $this->field_alias = $this->query
        ->add_field(NULL, getlocations_earth_distance_sql($coordinates['latitude'], $coordinates['longitude'], $this->table_alias), $this->table_alias . '_' . $this->field);
    }

    #else {

    #  $this->field_alias = $this->query->add_field(NULL, "'Unknown'", $this->table_alias . '_' . $this->field);

    #}
  }

}

Members

Namesort descending Modifiers Type Description Overrides
getlocations_fields_handler_field_distance::click_sort function Called to determine what to tell the clicksorter. Overrides views_handler_field::click_sort
getlocations_fields_handler_field_distance::extra_options_form function Provide a form for setting options. Overrides views_handler::extra_options_form
getlocations_fields_handler_field_distance::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. Overrides views_handler::has_extra_options
getlocations_fields_handler_field_distance::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
getlocations_fields_handler_field_distance::query function Called to add the field to a query. Overrides views_handler_field::query
getlocations_fields_handler_field_distance::render function Render the field. Overrides views_handler_field::render
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::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_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::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::get_value public function Get the value that's supposed to be rendered. 3
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_form public function Default options form provides the label widget that all fields should have. Overrides views_handler::options_form 33
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::pre_render public function Run before any fields are rendered. 8
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