1 views_plugin_pager_full.inc views_plugin_pager_full::options_form(&$form, &$form_state)

Provide the default form for setting options.

Overrides views_plugin::options_form

File

core/modules/views/plugins/views_plugin_pager_full.inc, line 55
Definition of views_plugin_pager_full.

Class

views_plugin_pager_full
The plugin to handle full pager.

Code

function options_form(&$form, &$form_state) {
  parent::options_form($form, $form_state);
  $pager_text = $this->display->handler->get_pager_text();
  $form['items_per_page'] = array(
    '#title' => $pager_text['items per page title'],
    '#type' => 'number',
    '#min' => '0',
    '#description' => $pager_text['items per page description'],
    '#default_value' => $this->options['items_per_page'],
  );

  $form['offset'] = array(
    '#type' => 'number',
    '#min' => '0',
    '#title' => t('Offset'),
    '#description' => t('The number of items to skip. For example, if this field is 3, the first 3 items will be skipped and not displayed.'),
    '#default_value' => $this->options['offset'],
  );

  $form['id'] = array(
    '#type' => 'textfield',
    '#title' => t('Pager ID'),
    '#description' => t("Unless you're experiencing problems with pagers related to this view, you should leave this at 0. If using multiple pagers on one page you may need to set this number to a higher value so as not to conflict within the ?page= array. Large values will add a lot of commas to your URLs, so avoid if possible."),
    '#default_value' => $this->options['id'],
  );

  $form['total_pages'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of pages'),
    '#description' => t('The total number of pages. Leave empty to show all pages.'),
    '#default_value' => $this->options['total_pages'],
  );

  $form['quantity'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of pager links visible'),
    '#description' => t('Specify the number of links to pages to display in the pager.'),
    '#default_value' => $this->options['quantity'],
  );

  $form['tags'] = array(
    '#type' => 'fieldset',
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
    '#tree' => TRUE,
    '#title' => t('Tags'),
    '#input' => TRUE,
    '#description' => t('A lists of labels for the controls in the pager'),
  );

  $form['tags']['first'] = array(
    '#type' => 'textfield',
    '#title' => t('Text for "first"-link'),
    '#description' => t('Text for "first"-link'),
    '#default_value' => $this->options['tags']['first'],
  );

  $form['tags']['previous'] = array(
    '#type' => 'textfield',
    '#title' => t('Text for "previous"-link'),
    '#description' => t('Text for "previous"-link'),
    '#default_value' => $this->options['tags']['previous'],
  );

  $form['tags']['next'] = array(
    '#type' => 'textfield',
    '#title' => t('Text for "next"-link'),
    '#description' => t('Text for "next"-link'),
    '#default_value' => $this->options['tags']['next'],
  );

  $form['tags']['last'] = array(
    '#type' => 'textfield',
    '#title' => t('Text for "last"-link'),
    '#description' => t('Text for "last"-link'),
    '#default_value' => $this->options['tags']['last'],
  );

  $form['expose'] = array(
    '#type' => 'fieldset',
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
    '#tree' => TRUE,
    '#title' => t('Exposed options'),
    '#input' => TRUE,
    '#description' => t('Exposing this options allows users to define their values in a exposed form when view is displayed'),
  );

  $form['expose']['items_per_page'] = array(
    '#type' => 'checkbox',
    '#title' => t('Expose items per page'),
    '#description' => t('When checked, users can determine how many items per page show in a view'),
    '#default_value' => $this->options['expose']['items_per_page'],
  );

  $form['expose']['items_per_page_label'] = array(
    '#type' => 'textfield',
    '#title' => t('Items per page label'),
    '#required' => TRUE,
    '#description' => t('Label to use in the exposed items per page form element.'),
    '#default_value' => $this->options['expose']['items_per_page_label'],
    '#states' => array(
      'invisible' => array(
        'input[name="pager_options[expose][items_per_page]"]' => array('checked' => FALSE),
      ),
    ),
  );

  $form['expose']['items_per_page_options'] = array(
    '#type' => 'textfield',
    '#title' => t('Exposed items per page options'),
    '#required' => TRUE,
    '#description' => t('Set between which values the user can choose when determining the items per page. Separated by comma.'),
    '#default_value' => $this->options['expose']['items_per_page_options'],
    '#states' => array(
      'invisible' => array(
        'input[name="pager_options[expose][items_per_page]"]' => array('checked' => FALSE),
      ),
    ),
  );


  $form['expose']['items_per_page_options_all'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include all items option'),
    '#description' => t('If checked, an extra item will be included to items per page to display all items'),
    '#default_value' => $this->options['expose']['items_per_page_options_all'],
  );

  $form['expose']['items_per_page_options_all_label'] = array(
    '#type' => 'textfield',
    '#title' => t('All items label'),
    '#description' => t('Which label will be used to display all items'),
    '#default_value' => $this->options['expose']['items_per_page_options_all_label'],
    '#states' => array(
      'invisible' => array(
        'input[name="pager_options[expose][items_per_page_options_all]"]' => array('checked' => FALSE),
      ),
    ),
  );

  $form['expose']['offset'] = array(
    '#type' => 'checkbox',
    '#title' => t('Expose Offset'),
    '#description' => t('When checked, users can determine how many items should be skipped at the beginning.'),
    '#default_value' => $this->options['expose']['offset'],
  );

  $form['expose']['offset_label'] = array(
    '#type' => 'textfield',
    '#title' => t('Offset label'),
    '#required' => TRUE,
    '#description' => t('Label to use in the exposed offset form element.'),
    '#default_value' => $this->options['expose']['offset_label'],
    '#states' => array(
      'invisible' => array(
        'input[name="pager_options[expose][offset]"]' => array('checked' => FALSE),
      ),
    ),
  );
}