You are here

Home » API reference » Views Atom 7 » views_plugin_style_atom_fields.inc » views_plugin_style_atom_fields

function views_plugin_style_atom_fields::option_definition in Views Atom 7

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

./views_plugin_style_atom_fields.inc, line 32
Style plugin for a standard Atom feed.

Class

views_plugin_style_atom_fields
@file Style plugin for a standard Atom feed.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['entry_type'] = array(
    'default' => 'text',
  );
  $options['entry_type_custom'] = array(
    'default' => '',
  );
  $options['description']['feed_description'] = array(
    'default' => '',
  );
  $options['fields'] = array(
    'default' => array(),
  );
  $options['guid'] = array(
    // TODO determine what this variable is.
    'use_feed' => array(
      'default' => array(),
    ),
  );
  return $options;
}