protected function SqlBase::defineOptions

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.

),

Return value

array Returns the options of this handler/plugin.

Overrides PluginBase::defineOptions

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/pager/SqlBase.php, line 15

Contains \Drupal\views\Plugin\views\pager\SqlBase

Class

SqlBase

A common base class for sql based pager.

Namespace

Code

protected function defineOptions() {
  $options = parent::defineOptions();
  $options['items_per_page'] = array(
    'default' => 10,
  );
  $options['offset'] = array(
    'default' => 0,
  );
  $options['id'] = array(
    'default' => 0,
  );
  $options['total_pages'] = array(
    'default' => '',
  );
  $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(
      'previous' => array(
        'default' => '‹ previous',
        'translatable' => TRUE,
      ),
      'next' => array(
        'default' => 'next ›',
        'translatable' => TRUE,
      ),
    ),
  );
  return $options;
}