You are here

Home » API reference » Date 7.3 » date_views_plugin_pager.inc » date_views_plugin_pager

public function date_views_plugin_pager::option_definition in Date 7.3

Same name and namespace in other branches
  1. 8 date_views/includes/date_views_plugin_pager.inc \date_views_plugin_pager::option_definition()
  2. 7.2 date_views/includes/date_views_plugin_pager.inc \date_views_plugin_pager::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_object::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

date_views/includes/date_views_plugin_pager.inc, line 90
Date pager.

Class

date_views_plugin_pager
Views pager plugin to page by month.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['date_id'] = array(
    'default' => 'date',
  );
  $options['pager_position'] = array(
    'default' => 'top',
  );
  $options['link_format'] = array(
    'default' => 'pager',
  );
  $options['date_argument'] = array(
    'default' => 'Unknown',
  );
  $options['granularity'] = array(
    'default' => 'Unknown',
  );
  $options['skip_empty_pages'] = array(
    'default' => FALSE,
  );
  return $options;
}