You are here

function getlocations_fields_handler_field_distance::option_definition in Get Locations 7

Same name and namespace in other branches
  1. 7.2 modules/getlocations_fields/handlers/getlocations_fields_handler_field_distance.inc \getlocations_fields_handler_field_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_field::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_field_distance.inc, line 14
getlocations_fields_handler_field_distance.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

Class

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

Code

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;
}