function SqlBase::buildOptionsForm

Provide the default form for setting options.

Overrides PluginBase::buildOptionsForm

File

core/modules/views/src/Plugin/views/pager/SqlBase.php, line 95

Class

SqlBase

A common base class for sql based pager.

Namespace

Code

public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $pager_text = $this->displayHandler
        ->getPagerText();
    $form['items_per_page'] = [
        '#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'] = [
        '#type' => 'number',
        '#min' => 0,
        '#title' => $this->t('Offset (number of items to skip)'),
        '#description' => $this->t('For example, set this to 3 and the first 3 items will not be displayed.'),
        '#default_value' => $this->options['offset'],
    ];
    $form['id'] = [
        '#type' => 'number',
        '#min' => 0,
        '#title' => $this->t('Pager ID'),
        '#description' => $this->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'] = [
        '#type' => 'number',
        '#min' => 0,
        '#title' => $this->t('Number of pages'),
        '#description' => $this->t('Leave empty to show all pages.'),
        '#default_value' => $this->options['total_pages'],
    ];
    $form['tags'] = [
        '#type' => 'details',
        '#open' => TRUE,
        '#tree' => TRUE,
        '#title' => $this->t('Pager link labels'),
        '#input' => TRUE,
    ];
    $form['tags']['previous'] = [
        '#type' => 'textfield',
        '#title' => $this->t('Previous page link text'),
        '#default_value' => $this->options['tags']['previous'],
    ];
    $form['tags']['next'] = [
        '#type' => 'textfield',
        '#title' => $this->t('Next page link text'),
        '#default_value' => $this->options['tags']['next'],
    ];
    $form['expose'] = [
        '#type' => 'details',
        '#open' => TRUE,
        '#tree' => TRUE,
        '#title' => $this->t('Exposed options'),
        '#input' => TRUE,
        '#description' => $this->t('Allow user to control selected display options for this view.'),
    ];
    $form['expose']['items_per_page'] = [
        '#type' => 'checkbox',
        '#title' => $this->t('Allow user to control the number of items displayed in this view'),
        '#default_value' => $this->options['expose']['items_per_page'],
    ];
    $form['expose']['items_per_page_label'] = [
        '#type' => 'textfield',
        '#title' => $this->t('Items per page label'),
        '#required' => TRUE,
        '#default_value' => $this->options['expose']['items_per_page_label'],
        '#states' => [
            'invisible' => [
                'input[name="pager_options[expose][items_per_page]"]' => [
                    'checked' => FALSE,
                ],
            ],
        ],
    ];
    $form['expose']['items_per_page_options'] = [
        '#type' => 'textfield',
        '#title' => $this->t('Exposed items per page options'),
        '#required' => TRUE,
        '#description' => $this->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' => [
            'invisible' => [
                'input[name="pager_options[expose][items_per_page]"]' => [
                    'checked' => FALSE,
                ],
            ],
        ],
    ];
    $form['expose']['items_per_page_options_all'] = [
        '#type' => 'checkbox',
        '#title' => $this->t('Allow user to display all items'),
        '#default_value' => $this->options['expose']['items_per_page_options_all'],
    ];
    $form['expose']['items_per_page_options_all_label'] = [
        '#type' => 'textfield',
        '#title' => $this->t('All items label'),
        '#default_value' => $this->options['expose']['items_per_page_options_all_label'],
        '#states' => [
            'invisible' => [
                'input[name="pager_options[expose][items_per_page_options_all]"]' => [
                    'checked' => FALSE,
                ],
            ],
        ],
    ];
    $form['expose']['offset'] = [
        '#type' => 'checkbox',
        '#title' => $this->t('Allow user to specify number of items skipped from beginning of this view.'),
        '#default_value' => $this->options['expose']['offset'],
    ];
    $form['expose']['offset_label'] = [
        '#type' => 'textfield',
        '#title' => $this->t('Offset label'),
        '#required' => TRUE,
        '#default_value' => $this->options['expose']['offset_label'],
        '#states' => [
            'invisible' => [
                'input[name="pager_options[expose][offset]"]' => [
                    'checked' => FALSE,
                ],
            ],
        ],
    ];
}