function party_plugin_display_party_piece::option_definition in Party 7

Same name and namespace in other branches

1. 8.2 includes/views/party_plugin_display_party_piece.inc \party_plugin_display_party_piece::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::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

includes/views/party_plugin_display_party_piece.inc, line 7

Views plugin for party pieces.

Class

party_plugin_display_party_piece

@file Views plugin for party pieces.

Code

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

  // @todo: we can't provide a usable default here because we don't have
  // access to the view or this display's ID (WTF?).
  // Hence add validation to prevent the view being saved with this default
  // unchanged.
  $options['party_piece_path'] = array(
    'default' => '',
  );
  $options['party_piece_label'] = array(
    'default' => 'Views',
  );

  // This is not set in the UI, but here for documentation.
  $options['data_set'] = array(
    'default' => '',
  );
  return $options;
}