You are here

Home » API reference » Calendar 7.2 » calendar_view_plugin_style.inc » calendar_view_plugin_style

function calendar_view_plugin_style::option_definition in Calendar 7.2

Same name and namespace in other branches
  1. 6.2 includes/calendar_view_plugin_style.inc \calendar_view_plugin_style::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

includes/calendar_view_plugin_style.inc, line 49
Views calendar style plugin for the Calendar module.

Class

calendar_view_plugin_style
Style plugin to render the year, month, week, or day calendar view.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['name_size'] = array(
    'default' => 3,
    'export' => 'export_plugin',
  );
  $options['with_weekno'] = array(
    'default' => 0,
    'export' => 'export_plugin',
  );
  $options['multiday_theme'] = array(
    'default' => module_exists('calendar_multiday') ? '1' : '0',
    'export' => 'export_plugin',
  );
  $options['theme_style'] = array(
    'default' => module_exists('calendar_multiday') ? '1' : '0',
    'export' => 'export_plugin',
  );
  $options['max_items'] = array(
    'default' => 0,
    'export' => 'export_plugin',
  );
  $options['max_items_behavior'] = array(
    'default' => 'more',
    'export' => 'export_plugin',
  );
  $options['groupby_times'] = array(
    'default' => 'hour',
    'export' => 'export_plugin',
  );
  $options['groupby_times_custom'] = array(
    'default' => '',
    'export' => 'export_plugin',
  );
  $options['groupby_field'] = array(
    'default' => '',
    'export' => 'export_plugin',
  );
  return $options;
}