You are here

Home » API reference » Views OAI-PMH 7.3 » views_oai_pmh_plugin_display.inc » views_oai_pmh_plugin_display

public function views_oai_pmh_plugin_display::option_definition in Views OAI-PMH 7.3

Same name and namespace in other branches
  1. 6.2 plugins/views_oai_pmh_plugin_display.inc \views_oai_pmh_plugin_display::option_definition()
  2. 6 plugins/views_oai_pmh_plugin_display.inc \views_oai_pmh_plugin_display::option_definition()
  3. 7 plugins/views_oai_pmh_plugin_display.inc \views_oai_pmh_plugin_display::option_definition()
  4. 7.2 plugins/views_oai_pmh_plugin_display.inc \views_oai_pmh_plugin_display::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_plugin_display_page::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

plugins/views_oai_pmh_plugin_display.inc, line 23
Contains the OAI-PMH display plugin.

Class

views_oai_pmh_plugin_display
The views_oai_pmh_plugin_display Class.

Code

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

  // Overrides for standard stuff:
  $options['style_plugin']['default'] = 'views_oai_pmh_style';
  $options['defaults']['default']['style_plugin'] = FALSE;
  $options['defaults']['default']['style_options'] = FALSE;
  $options['row_plugin']['default'] = '';
  $options['defaults']['default']['row_plugin'] = FALSE;
  $options['defaults']['default']['row_options'] = FALSE;

  // Set default title.
  $options['title']['default'] = variable_get('site_name', 'OAI-PMH');
  $options['defaults']['default']['title'] = FALSE;
  return $options;
}