You are here

Home » API reference » References dialog 7 » references_dialog_plugin_display.inc » references_dialog_plugin_display

function references_dialog_plugin_display::option_definition in References dialog 7

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

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/references_dialog_plugin_display.inc, line 14
Contains the default display plugin.

Class

references_dialog_plugin_display
A plugin to handle defaults on a view.

Code

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

  // Allow the use of any style plugin.
  unset($options['style_plugin']['default']);
  $options['defaults']['default']['style_plugin'] = TRUE;
  $options['defaults']['default']['style_options'] = FALSE;
  $options['row_plugin']['default'] = 'fields';
  $options['defaults']['default']['row_plugin'] = FALSE;
  $options['defaults']['default']['row_options'] = FALSE;

  // Set the things we actually add with this plugin.
  $options['attach'] = array(
    'default' => array(),
  );
  return $options;
}