You are here

Home » API reference » Chaos Tool Suite (ctools) 7 » views_content_plugin_display_panel_pane.inc » views_content_plugin_display_panel_pane

public function views_content_plugin_display_panel_pane::option_definition in Chaos Tool Suite (ctools) 7

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

views_content/plugins/views/views_content_plugin_display_panel_pane.inc, line 18

Class

views_content_plugin_display_panel_pane
The plugin that handles a panel_pane.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['pane_title'] = array(
    'default' => '',
    'translatable' => TRUE,
  );
  $options['pane_description'] = array(
    'default' => '',
    'translatable' => TRUE,
  );
  $options['pane_category'] = array(
    'contains' => array(
      'name' => array(
        'default' => 'View panes',
        'translatable' => TRUE,
      ),
      'weight' => array(
        'default' => 0,
      ),
    ),
  );
  $options['allow'] = array(
    'contains' => array(
      'use_pager' => array(
        'default' => FALSE,
      ),
      'items_per_page' => array(
        'default' => FALSE,
      ),
      'offset' => array(
        'default' => FALSE,
      ),
      'link_to_view' => array(
        'default' => FALSE,
      ),
      'more_link' => array(
        'default' => FALSE,
      ),
      'path_override' => array(
        'default' => FALSE,
      ),
      'title_override' => array(
        'default' => FALSE,
      ),
      'exposed_form' => array(
        'default' => FALSE,
      ),
      'fields_override' => array(
        'default' => FALSE,
      ),
    ),
  );
  $options['argument_input'] = array(
    'default' => array(),
  );
  $options['link_to_view'] = array(
    'default' => 0,
  );
  $options['inherit_panels_path'] = array(
    'default' => 0,
  );
  return $options;
}