You are here

Home » API reference » Views Auto-Refresh 7 » views_autorefresh_handler_area_autorefresh.inc » views_autorefresh_handler_area_autorefresh

function views_autorefresh_handler_area_autorefresh::option_definition in Views Auto-Refresh 7

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

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/views_autorefresh_handler_area_autorefresh.inc, line 19

Class

views_autorefresh_handler_area_autorefresh
Base class for area handlers.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['interval'] = array(
    'default' => '',
  );
  $options['nodejs'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['incremental'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['display'] = array(
    'default' => '',
  );
  $options['incremental_advanced'] = array(
    'contains' => array(
      'sourceSelector' => array(
        'default' => '.view-content',
      ),
      'targetSelector' => array(
        'default' => '.view-content',
      ),
      'emptySelector' => array(
        'default' => '.view-empty',
      ),
      'afterSelector' => array(
        'default' => '.view-header',
      ),
      'targetStructure' => array(
        'default' => '<div class="view-content"></div>',
      ),
      'firstClass' => array(
        'default' => 'views-row-first',
      ),
      'lastClass' => array(
        'default' => 'views-row-last',
      ),
      'oddClass' => array(
        'default' => 'views-row-odd',
      ),
      'evenClass' => array(
        'default' => 'views-row-even',
      ),
      'rowClassPrefix' => array(
        'default' => 'views-row-',
      ),
    ),
  );
  $options['ping'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['ping_base_path'] = array(
    'default' => '',
  );
  $options['ping_arguments'] = array(
    'default' => '',
  );
  $options['trigger_onload'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  return $options;
}