You are here

Home » API reference » Date 7.2 » date_views_argument_handler.inc » date_views_argument_handler

public function date_views_argument_handler::option_definition in Date 7.2

Same name and namespace in other branches
  1. 8 date_views/includes/date_views_argument_handler.inc \date_views_argument_handler::option_definition()
  2. 7.3 date_views/includes/date_views_argument_handler.inc \date_views_argument_handler::option_definition()
  3. 7 date_views/includes/date_views_argument_handler.inc \date_views_argument_handler::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 date_views_argument_handler_simple::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

date_views/includes/date_views_argument_handler.inc, line 35
Date API views argument handler.

Class

date_views_argument_handler
Date API argument handler.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['date_fields'] = array(
    'default' => array(),
  );
  $options['date_method'] = array(
    'default' => 'OR',
  );
  $options['date_group'] = array(
    'default' => 'date',
  );

  // There is no easy way to do summary queries on multiple fields, so remove
  // that option; leaving this variable in place causes problems with Features
  // exports.
  unset($options['summary']);
  return $options;
}