You are here

Home » API reference » Forena Reports 7.3 » ForenaViewsPlugin.inc » ForenaViewsPlugin

function ForenaViewsPlugin::option_definition in Forena Reports 7.3

Same name and namespace in other branches
  1. 7.5 ForenaViewsPlugin.inc \ForenaViewsPlugin::option_definition()
  2. 7.4 ForenaViewsPlugin.inc \ForenaViewsPlugin::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_style::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

./ForenaViewsPlugin.inc, line 10
ForenaViewsPlugin.inc Views plugin to use forena report as a views renderer. @author davidmetzler

Class

ForenaViewsPlugin
@file ForenaViewsPlugin.inc Views plugin to use forena report as a views renderer. @author davidmetzler

Code

function option_definition() {
  $options = parent::option_definition();
  $options['report_name'] = array(
    'default' => 'reports/test',
  );
  return $options;
}