You are here

function getlocations_fields_handler_filter_distance::option_definition in Get Locations 7

Same name and namespace in other branches
  1. 7.2 modules/getlocations_fields/handlers/getlocations_fields_handler_filter_distance.inc \getlocations_fields_handler_filter_distance::option_definition()

Information about options for all kinds of purposes will be held here.

@code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_handler_filter::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

modules/getlocations_fields/handlers/getlocations_fields_handler_filter_distance.inc, line 19
getlocations_fields_handler_filter_distance.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

Class

getlocations_fields_handler_filter_distance
General proximity filter for location latitude/longitude.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['operator'] = array(
    'default' => 'mbr',
  );
  $options['identifier'] = array(
    'default' => 'distance',
  );
  $options['group'] = array(
    'default' => '0',
  );
  $options['origin'] = array(
    'default' => 'nid_arg',
  );
  $options['settings']['searchbox_size'] = array(
    'default' => '60',
  );
  $options['settings']['restrict_by_country'] = array(
    'default' => 0,
  );
  $options['settings']['country'] = array(
    'default' => variable_get('site_default_country', ''),
  );
  $options['settings']['display_search_distance'] = array(
    'default' => 1,
  );
  $options['settings']['display_search_units'] = array(
    'default' => 1,
  );
  $options['settings']['geocoder_enable'] = array(
    'default' => 0,
  );
  $options['value'] = array(
    'default' => array(
      'latitude' => '',
      'longitude' => '',
      #        'postal_code' => '',

      #        'country' => '',
      'php_code' => '',
      'nid_arg' => '',
      'nid_loc_field' => 'node',
      'uid_arg' => '',
      'uid_loc_field' => 'user',
      'tid_arg' => '',
      'tid_loc_field' => 'taxonomy_term',
      'cid_arg' => '',
      'cid_loc_field' => 'comment',
      'search_distance' => 100,
      'search_units' => 'km',
      'search_field' => '',
      'gps' => '',
    ),
  );
  $options['expose']['contains']['operator_id'] = array(
    'default' => 'mbr',
  );
  $options['expose']['contains']['search_units'] = array(
    'default' => 'km',
  );
  $options['expose']['contains']['search_distance'] = array(
    'default' => 10,
  );
  $options['expose']['contains']['search_field'] = array(
    'default' => '',
  );
  return $options;
}