You are here

Home » API reference » Display Suite 7.2 » views_plugin_ds_entity_view.inc » views_plugin_ds_entity_view

function views_plugin_ds_entity_view::option_definition in Display Suite 7.2

Same name and namespace in other branches
  1. 7 views/views_plugin_ds_entity_view.inc \views_plugin_ds_entity_view::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_row::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/views_plugin_ds_entity_view.inc, line 50
Provides the Display Suite views entity style plugin.

Class

views_plugin_ds_entity_view
Plugin which defines the view mode on the resulting entity object.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['view_mode'] = array(
    'default' => 'teaser',
  );
  $options['load_comments'] = array(
    'default' => FALSE,
  );
  $options['alternating'] = array(
    'default' => FALSE,
  );
  $options['changing'] = array(
    'default' => FALSE,
  );
  $options['grouping'] = array(
    'default' => FALSE,
  );
  $options['advanced'] = array(
    'default' => FALSE,
  );
  $options['delta_fieldset'] = array(
    'contains' => array(
      'delta_fields' => array(
        'default' => FALSE,
      ),
    ),
  );
  $options['grouping_fieldset'] = array(
    'contains' => array(
      'grouping' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'group_odd_even' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'group_field' => array(
        'default' => '',
      ),
      'group_field_function' => array(
        'default' => '',
      ),
    ),
  );
  $options['default_fieldset'] = array(
    'contains' => array(
      'view_mode' => array(
        'default' => '',
      ),
    ),
  );
  $options['switch_fieldset'] = array(
    'contains' => array(
      'switch' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
    ),
  );
  $options['alternating_fieldset'] = array(
    'contains' => array(
      'alternating' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'allpages' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'item' => array(
        'default' => array(),
        'export' => 'ds_item_export_option',
      ),
    ),
  );
  $options['advanced_fieldset'] = array(
    'contains' => array(
      'advanced' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
    ),
  );
  return $options;
}