You are here

Home » API reference » Location 7.5 » location_views_handler_filter_proximity.inc » location_views_handler_filter_proximity

function location_views_handler_filter_proximity::option_definition in Location 7.5

Same name and namespace in other branches
  1. 6.3 handlers/location_views_handler_filter_proximity.inc \location_views_handler_filter_proximity::option_definition()
  2. 7.3 handlers/location_views_handler_filter_proximity.inc \location_views_handler_filter_proximity::option_definition()
  3. 7.4 handlers/location_views_handler_filter_proximity.inc \location_views_handler_filter_proximity::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

handlers/location_views_handler_filter_proximity.inc, line 10

Class

location_views_handler_filter_proximity
General proximity filter for location latitude/longitude.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['operator'] = array(
    'default' => 'mbr',
  );
  $options['identifier'] = array(
    'default' => 'dist',
  );
  $options['origin'] = array(
    'default' => 'user',
  );
  $options['value'] = array(
    'default' => array(
      'latitude' => '',
      'longitude' => '',
      'postal_code' => '',
      'country' => '',
      'php_code' => '',
      'nid_arg' => '',
      'nid_loc_field' => 'node',
      'uid_arg' => '',
      'search_distance' => 100,
      'search_units' => 'mile',
    ),
  );
  $options['expose']['contains']['gmap_macro'] = array(
    'default' => '[gmap ]',
  );
  $options['expose']['contains']['user_location_choose'] = array(
    'default' => FALSE,
  );
  return $options;
}