protected function AlphaPaginationArea::defineOptions in Views Alpha Pagination 8.2

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

'option_name' => array(
 - 'default' => default value,
 - '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().
 ),

Return value

array Returns the options of this handler/plugin.

Overrides AreaPluginBase::defineOptions

File

src/Plugin/views/area/AlphaPaginationArea.php, line 87

Class

AlphaPaginationArea

Views area handler to display alphabetic pagination.

Namespace

Drupal\alpha_pagination\Plugin\views\area

Code

protected function defineOptions() {
  $options = parent::defineOptions();

  // Global.
  $options['paginate_view_relationship'] = [
    'default' => 'none',
    'translatable' => TRUE,
  ];
  $options['paginate_view_field'] = [
    'default' => 'title',
    'translatable' => TRUE,
  ];

  // Link.
  $options['paginate_link_path'] = [
    'default' => '[alpha_pagination:path]/[alpha_pagination:value]',
    'translatable' => FALSE,
  ];
  $options['paginate_link_external'] = [
    'default' => 0,
    'translatable' => FALSE,
  ];
  $options['paginate_link_class'] = [
    'default' => '',
    'translatable' => FALSE,
  ];
  $options['paginate_link_attributes'] = [
    'default' => '',
    'translatable' => FALSE,
  ];

  // Classes.
  $options['paginate_class'] = [
    'default' => 'alpha-pagination',
    'translatable' => FALSE,
  ];
  $options['paginate_list_class'] = [
    'default' => 'alpha-pagination-list',
    'translatable' => FALSE,
  ];
  $options['paginate_active_class'] = [
    'default' => 'active',
    'translatable' => FALSE,
  ];
  $options['paginate_inactive_class'] = [
    'default' => 'inactive',
    'translatable' => FALSE,
  ];

  // All.
  $options['paginate_all_display'] = [
    'default' => 1,
    'translatable' => FALSE,
  ];
  $options['paginate_all_class'] = [
    'default' => 'all',
    'translatable' => FALSE,
  ];
  $options['paginate_all_label'] = [
    'default' => t('All'),
    'translatable' => TRUE,
  ];
  $options['paginate_all_value'] = [
    'default' => 'all',
    'translatable' => FALSE,
  ];
  $options['paginate_all_position'] = [
    'default' => 'after',
    'translatable' => FALSE,
  ];
  $options['paginate_toggle_empty'] = [
    'default' => 1,
    'translatable' => FALSE,
  ];

  // Numeric.
  $options['paginate_view_numbers'] = [
    'default' => 0,
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_class'] = [
    'default' => 'numeric',
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_divider'] = [
    'default' => 1,
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_divider_class'] = [
    'default' => '-',
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_hide_empty'] = [
    'default' => 1,
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_label'] = [
    'default' => '#',
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_position'] = [
    'default' => 'before',
    'translatable' => FALSE,
  ];
  $options['paginate_numeric_value'] = [
    'default' => implode('+', $this->alphaPagination
      ->getNumbers()),
    'translatable' => FALSE,
  ];
  return $options;
}