You are here

Home » API reference » Geofield 7.2 » geofield_handler_filter.inc » geofield_handler_filter

function geofield_handler_filter::option_definition in Geofield 7.2

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_numeric::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/handlers/geofield_handler_filter.inc, line 96
Distance filter implementation.

Class

geofield_handler_filter
@file Distance filter implementation.

Code

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

  // Data sources and info needed.
  $options['source'] = array(
    'default' => 'manual',
  );
  $options['value'] = array(
    'default' => array(
      'distance' => 100,
      'distance2' => 200,
      'unit' => GEOFIELD_KILOMETERS,
      'origin' => array(),
    ),
  );
  $proximityHandlers = module_invoke_all('proximity_views_handlers');
  foreach ($proximityHandlers as $key => $handler) {
    if (class_exists($handler['class'])) {
      $proximityPlugin = new $handler['class']();
      $proximityPlugin
        ->option_definition($options, $this);
    }
  }
  return $options;
}