You are here

Home » API reference » Location 7.3 » location_handler_argument_location_proximity.inc » location_handler_argument_location_proximity

public function location_handler_argument_location_proximity::option_definition in Location 7.3

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

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

handlers/location_handler_argument_location_proximity.inc, line 17
Location proximity argument handler.

Class

location_handler_argument_location_proximity

Code

public function option_definition() {
  $options = parent::option_definition();

  // As only us and uk use miles, make km the default otherwise.
  $country = variable_get('location_default_country', 'us');
  $options['search_units'] = array(
    'default' => $country == 'us' || $country == 'uk' ? 'mile' : 'km',
  );
  $options['search_method'] = array(
    'default' => 'mbr',
  );
  $options['type'] = array(
    'default' => 'postal',
  );
  return $options;
}