You are here

Home » API reference » Similar By Terms 7.2 » similarterms_handler_sort_similar.inc » similarterms_handler_sort_similar

function similarterms_handler_sort_similar::option_definition in Similar By Terms 7.2

Same name and namespace in other branches
  1. 6.2 views/similarterms_handler_sort_similar.inc \similarterms_handler_sort_similar::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_sort::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/similarterms_handler_sort_similar.inc, line 10

Class

similarterms_handler_sort_similar
Handler which sorts the by the similarity.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['order'] = array(
    'default' => 'DESC',
  );
  return $options;
}