function views_handler_area_alpha_pagination::option_definition in Views Alpha Pagination 7.2

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

src/views_handler_area_alpha_pagination.inc, line 33

Class

views_handler_area_alpha_pagination

Views area handler to display alphabetic pagination.

Code

function option_definition() {
  $options = parent::option_definition();

  // Global.
  $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' => 'numeric-divider',
    '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;
}