You are here

function views_plugin_display_page_db::option_definition in Dynamic Background 7.2

Same name and namespace in other branches
  1. 6 modules/dynamic_background_views/views/plugins/views_plugin_display_page_db.inc \views_plugin_display_page_db::option_definition()
  2. 7 modules/dynamic_background_views/views/plugins/views_plugin_display_page_db.inc \views_plugin_display_page_db::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

modules/dynamic_background_views/views/plugins/views_plugin_display_page_db.inc, line 15
Contains the dynamic background views page display plugin, which is an extension of the std. view page display.

Class

views_plugin_display_page_db
The plugin that handles a full page.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['dynamic_background'] = array(
    'title' => 'Dynamic background',
    'description' => t('Select a background for the current page.'),
    'default' => t('No image'),
  );
  return $options;
}