You are here

function draggableviews_handler_field_draggable::option_definition in DraggableViews 7.2

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_handler_field::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/draggableviews_handler_field_draggable.inc, line 16
Views field handler. Contains all relevant Draggableviews options and related logic. Implements the Views Form API.

Class

draggableviews_handler_field_draggable
@file Views field handler. Contains all relevant Draggableviews options and related logic. Implements the Views Form API.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['draggableviews'] = array(
    'contains' => array(
      'handler' => array(
        'default' => 'draggableviews_handler_native',
      ),
      'hierarchy_handler' => array(
        'default' => '',
      ),
      'save_button_label' => array(
        'default' => 'Save',
      ),
      'ajax' => array(
        'default' => FALSE,
      ),
    ),
  );

  // Populate default values of form elements provided by handlers.
  foreach (draggableviews_get_handlers() as $handler_id => $handler_object) {
    $options['draggableviews']['contains'][$handler_id] = array(
      'default' => $handler_object
        ->option_definition(),
    );
  }
  foreach (draggableviews_get_hierarchy_handlers() as $handler_id => $handler_object) {
    $options['draggableviews']['contains'][$handler_id] = array(
      'default' => $handler_object
        ->option_definition(),
    );
  }
  return $options;
}