public function views_plugin_pager_full::option_definition in Views (for Drupal 7) 7.3

Same name and namespace in other branches

1. 6.3 plugins/views_plugin_pager_full.inc \views_plugin_pager_full::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()

1 call to views_plugin_pager_full::option_definition()

views_plugin_pager_mini::option_definition in plugins/views_plugin_pager_mini.inc

Information about options for all kinds of purposes will be held here.

1 method overrides views_plugin_pager_full::option_definition()

views_plugin_pager_mini::option_definition in plugins/views_plugin_pager_mini.inc

Information about options for all kinds of purposes will be held here.

File

plugins/views_plugin_pager_full.inc, line 28

Definition of views_plugin_pager_full.

Class

views_plugin_pager_full

The plugin to handle full pager.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['items_per_page'] = array(
    'default' => 10,
  );
  $options['offset'] = array(
    'default' => 0,
  );
  $options['id'] = array(
    'default' => 0,
  );
  $options['total_pages'] = array(
    'default' => '',
  );

  // Use the same default quantity that core uses by default.
  $options['quantity'] = array(
    'default' => 9,
  );
  $options['expose'] = array(
    'contains' => array(
      'items_per_page' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'items_per_page_label' => array(
        'default' => 'Items per page',
        'translatable' => TRUE,
      ),
      'items_per_page_options' => array(
        'default' => '5, 10, 20, 40, 60',
      ),
      'items_per_page_options_all' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'items_per_page_options_all_label' => array(
        'default' => '- All -',
        'translatable' => TRUE,
      ),
      'offset' => array(
        'default' => FALSE,
        'bool' => TRUE,
      ),
      'offset_label' => array(
        'default' => 'Offset',
        'translatable' => TRUE,
      ),
    ),
  );
  $options['tags'] = array(
    'contains' => array(
      'first' => array(
        'default' => '« first',
        'translatable' => TRUE,
      ),
      'previous' => array(
        'default' => '‹ previous',
        'translatable' => TRUE,
      ),
      'next' => array(
        'default' => 'next ›',
        'translatable' => TRUE,
      ),
      'last' => array(
        'default' => 'last »',
        'translatable' => TRUE,
      ),
    ),
  );
  return $options;
}