class geolocation_proximity_views_handler_field_distance in Geolocation Proximity 7.2

Distance field handler for views.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \geolocation_proximity_views_handler_field_distance

Expanded class hierarchy of geolocation_proximity_views_handler_field_distance

1 string reference to 'geolocation_proximity_views_handler_field_distance'

geolocation_proximity_field_views_data_alter in ./geolocation_proximity.views.inc: Implements hook_field_views_data_alter()

File

handlers/geolocation_proximity_views_handler_field_distance.inc, line 10: Definition of geolocation_proximity_views_handler_field_distance.

View source

class geolocation_proximity_views_handler_field_distance extends views_handler_field {

  /**
   * init the handler with necessary data.
   */
  function init(&$view, &$options) {
    parent::init($view, $options);
    $field_id = str_replace('_distance', '', $this->real_field);

    // $this->additional_fields = array(
    //   $field_id . '_lat_sin',
    //   $field_id . '_lat_cos',
    //   $field_id . '_lng_rad',
    // );
    $this->geolocation_proximity_field_id = $field_id;
    $this->field_alias = $this->options['id'] . '_field';
  }

  /**
   * Information about options for all kinds of purposes will be held here.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['exposed'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    $options['expose'] = array(
      'contains' => array(
        'operator_id' => array(
          'default' => FALSE,
        ),
        'label' => array(
          'default' => '',
          'translatable' => TRUE,
        ),
        'use_operator' => array(
          'default' => FALSE,
          'bool' => TRUE,
        ),
        'operator' => array(
          'default' => '',
        ),
        'identifier' => array(
          'default' => '',
        ),
        'required' => array(
          'default' => FALSE,
          'bool' => TRUE,
        ),
        'remember' => array(
          'default' => FALSE,
          'bool' => TRUE,
        ),
        'multiple' => array(
          'default' => FALSE,
          'bool' => TRUE,
        ),
      ),
    );
    return $options;
  }

  /**
   * If a handler has 'extra options' it will get a little settings widget and
   * another form called extra_options.
   */
  function has_extra_options() {
    return TRUE;
  }

  /**
   * Provide defaults for the handler.
   */
  function extra_options(&$option) {
    $option['use_filter'] = FALSE;
    $option['location'] = array(
      'latitude' => 0,
      'longitude' => 0,
    );
  }

  /**
   * Provide a form for setting options.
   */
  function extra_options_form(&$form, &$form_state) {
    $filters = array(
      '' => t(' - Use own values - '),
    );
    foreach ($this->view
      ->get_items('filter') as $filter) {
      if (preg_match('/^' . $this->real_field . '/', $filter['field'])) {
        $filters[$filter['id']] = $filter['ui_name'] ? $filter['ui_name'] . " ({$filter['field']})" : $filter['field'];
      }
    }
    $form['use_filter'] = array(
      '#type' => 'select',
      '#options' => $filters,
      '#title' => t('Use filter'),
      '#default_value' => $this->options['use_filter'],
      '#description' => t('This field requires a location (latitude, longitude) to use as reference for calculating the distance. If there are filters for this same field, the location set for the given filter can be used. If not one needs to be provided.'),
    );
    $form['location'] = array(
      '#tree' => TRUE,
      '#type' => 'fieldset',
      '#title' => t('Default location'),
      '#states' => array(
        // Only show this field when the 'toggle_me' checkbox is enabled.
        'visible' => array(
          '[name="options[use_filter]"]' => array(
            'value' => '',
          ),
        ),
      ),
    );
    $form['location']['latitude'] = array(
      '#type' => 'textfield',
      '#title' => t('Latitude'),
      '#required' => TRUE,
      '#default_value' => $this->options['location']['latitude'],
      '#weight' => 1,
    );
    $form['location']['longitude'] = array(
      '#type' => 'textfield',
      '#title' => t('Longitude'),
      '#required' => TRUE,
      '#default_value' => $this->options['location']['longitude'],
      '#weight' => 2,
    );
  }

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

  /**
   * Render our chunk of the exposed handler form when selecting
   */
  function exposed_form(&$form, &$form_state) {
    $field_id = $this->geolocation_proximity_field_id;
    $form[$this->field_alias] = array(
      '#tree' => TRUE,
      '#title' => $this->options['label'],
      '#type' => 'item',
    );
    $form[$this->field_alias]['latitude'] = array(
      '#type' => 'textfield',
      '#title' => t('Latitude'),
      '#required' => TRUE,
      '#default_value' => $this->options['location']['latitude'],
      '#weight' => 1,
    );
    $form[$this->field_alias]['longitude'] = array(
      '#type' => 'textfield',
      '#title' => t('Longitude'),
      '#required' => TRUE,
      '#default_value' => $this->options['location']['longitude'],
      '#weight' => 2,
    );
  }

  /**
   * Validate the exposed handler form
   */
  function exposed_validate(&$form, &$form_state) {
    if (!$this
      ->can_expose()) {
      return;
    }
    $field_id = $this->geolocation_proximity_field_id;
    $this
      ->latlng_validate($form[$this->field_alias], $form_state['values'][$this->field_alias]);
  }

  /**
   * Submit the exposed handler form.
   */
  function exposed_submit(&$form, &$form_state) {
    if (!$this
      ->can_expose()) {
      return;
    }
    $field_id = $this->geolocation_proximity_field_id;
    $this->options['location']['latitude'] = $form_state['values'][$this->field_alias]['latitude'];
    $this->options['location']['longitude'] = $form_state['values'][$this->field_alias]['longitude'];
  }

  /**
   * Validate the latitude and longitude values
   */
  function latlng_validate(&$elements, &$values) {
    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;
    }
    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;
    }
  }

  /**
   * Determine if a handler can be exposed.
   */
  function can_expose() {
    return $this->options['use_filter'] ? FALSE : TRUE;
  }

  /**
   * Called to add the field to a query.
   */
  function query() {
    if (!$this->options['use_filter']) {
      $this
        ->ensure_my_table();
      $this
        ->add_additional_fields();
      $table = $this->table_alias;
      $field_id = $this->geolocation_proximity_field_id;

      // Prepare filter values.
      $filter_lat = $this->options['location']['latitude'];
      $filter_lng = $this->options['location']['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);
      $this->query
        ->add_field(NULL, $sql, $this->field_alias);
    }
  }

  /**
   * Render the field.
   *
   * @param array $values
   *   The values retrieved from the database.
   */
  function render($values) {
    if ($this->options['use_filter']) {
      $distance = $values->{$this->options['use_filter'] . '_filter'};
    }
    else {
      $distance = $this
        ->get_value($values);
    }
    return t('@distance km.', array(
      '@distance' => number_format($distance, 2),
    ));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
geolocation_proximity_views_handler_field_distance::can_expose		function	Determine if a handler can be exposed. Overrides views_handler::can_expose
geolocation_proximity_views_handler_field_distance::exposed_form		function	Render our chunk of the exposed handler form when selecting Overrides views_handler::exposed_form
geolocation_proximity_views_handler_field_distance::exposed_submit		function	Submit the exposed handler form. Overrides views_handler::exposed_submit
geolocation_proximity_views_handler_field_distance::exposed_validate		function	Validate the exposed handler form Overrides views_handler::exposed_validate
geolocation_proximity_views_handler_field_distance::extra_options		function	Provide defaults for the handler. Overrides views_handler::extra_options
geolocation_proximity_views_handler_field_distance::extra_options_form		function	Provide a form for setting options. Overrides views_handler::extra_options_form
geolocation_proximity_views_handler_field_distance::extra_options_validate		function	Validate the options form. Overrides views_handler::extra_options_validate
geolocation_proximity_views_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
geolocation_proximity_views_handler_field_distance::init		function	init the handler with necessary data. Overrides views_handler_field::init
geolocation_proximity_views_handler_field_distance::latlng_validate		function	Validate the latitude and longitude values
geolocation_proximity_views_handler_field_distance::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
geolocation_proximity_views_handler_field_distance::query		function	Called to add the field to a query. Overrides views_handler_field::query
geolocation_proximity_views_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::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_info	public	function	Get information about the exposed form for the form renderer.	1
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_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::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_sort	public	function	Called to determine what to tell the clicksorter.	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::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

You are here

class geolocation_proximity_views_handler_field_distance in Geolocation Proximity 7.2

Hierarchy

File

Members

API Navigation