www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/src/Plugin/views/pager/SqlBase.php

   1 <?php
   2
   3 namespace Drupal\views\Plugin\views\pager;
   4
   5 use Drupal\Core\Cache\Cache;
   6 use Drupal\Core\Cache\CacheableDependencyInterface;
   7 use Drupal\Core\Form\FormStateInterface;
   8
   9 /**
  10  * A common base class for sql based pager.
  11  */
  12 abstract class SqlBase extends PagerPluginBase implements CacheableDependencyInterface {
  13
  14   protected function defineOptions() {
  15     $options = parent::defineOptions();
  16     $options['items_per_page'] = ['default' => 10];
  17     $options['offset'] = ['default' => 0];
  18     $options['id'] = ['default' => 0];
  19     $options['total_pages'] = ['default' => ''];
  20     $options['expose'] = [
  21       'contains' => [
  22         'items_per_page' => ['default' => FALSE],
  23         'items_per_page_label' => ['default' => $this->t('Items per page')],
  24         'items_per_page_options' => ['default' => '5, 10, 25, 50'],
  25         'items_per_page_options_all' => ['default' => FALSE],
  26         'items_per_page_options_all_label' => ['default' => $this->t('- All -')],
  27
  28         'offset' => ['default' => FALSE],
  29         'offset_label' => ['default' => $this->t('Offset')],
  30       ],
  31     ];
  32     $options['tags'] = [
  33       'contains' => [
  34         'previous' => ['default' => $this->t('‹ Previous')],
  35         'next' => ['default' => $this->t('Next ›')],
  36       ],
  37     ];
  38     return $options;
  39   }
  40
  41   /**
  42    * Provide the default form for setting options.
  43    */
  44   public function buildOptionsForm(&$form, FormStateInterface $form_state) {
  45     parent::buildOptionsForm($form, $form_state);
  46     $pager_text = $this->displayHandler->getPagerText();
  47     $form['items_per_page'] = [
  48       '#title' => $pager_text['items per page title'],
  49       '#type' => 'number',
  50       '#description' => $pager_text['items per page description'],
  51       '#default_value' => $this->options['items_per_page'],
  52     ];
  53
  54     $form['offset'] = [
  55       '#type' => 'number',
  56       '#title' => $this->t('Offset (number of items to skip)'),
  57       '#description' => $this->t('For example, set this to 3 and the first 3 items will not be displayed.'),
  58       '#default_value' => $this->options['offset'],
  59     ];
  60
  61     $form['id'] = [
  62       '#type' => 'number',
  63       '#title' => $this->t('Pager ID'),
  64       '#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."),
  65       '#default_value' => $this->options['id'],
  66     ];
  67
  68     $form['total_pages'] = [
  69       '#type' => 'number',
  70       '#title' => $this->t('Number of pages'),
  71       '#description' => $this->t('Leave empty to show all pages.'),
  72       '#default_value' => $this->options['total_pages'],
  73     ];
  74
  75     $form['tags'] = [
  76       '#type' => 'details',
  77       '#open' => TRUE,
  78       '#tree' => TRUE,
  79       '#title' => $this->t('Pager link labels'),
  80       '#input' => TRUE,
  81     ];
  82
  83     $form['tags']['previous'] = [
  84       '#type' => 'textfield',
  85       '#title' => $this->t('Previous page link text'),
  86       '#default_value' => $this->options['tags']['previous'],
  87     ];
  88
  89     $form['tags']['next'] = [
  90       '#type' => 'textfield',
  91       '#title' => $this->t('Next page link text'),
  92       '#default_value' => $this->options['tags']['next'],
  93     ];
  94
  95     $form['expose'] = [
  96       '#type' => 'details',
  97       '#open' => TRUE,
  98       '#tree' => TRUE,
  99       '#title' => $this->t('Exposed options'),
 100       '#input' => TRUE,
 101       '#description' => $this->t('Allow user to control selected display options for this view.'),
 102     ];
 103
 104     $form['expose']['items_per_page'] = [
 105       '#type' => 'checkbox',
 106       '#title' => $this->t('Allow user to control the number of items displayed in this view'),
 107       '#default_value' => $this->options['expose']['items_per_page'],
 108     ];
 109
 110     $form['expose']['items_per_page_label'] = [
 111       '#type' => 'textfield',
 112       '#title' => $this->t('Items per page label'),
 113       '#required' => TRUE,
 114       '#default_value' => $this->options['expose']['items_per_page_label'],
 115       '#states' => [
 116         'invisible' => [
 117           'input[name="pager_options[expose][items_per_page]"]' => ['checked' => FALSE],
 118         ],
 119       ],
 120     ];
 121
 122     $form['expose']['items_per_page_options'] = [
 123       '#type' => 'textfield',
 124       '#title' => $this->t('Exposed items per page options'),
 125       '#required' => TRUE,
 126       '#description' => $this->t('Set between which values the user can choose when determining the items per page. Separated by comma.'),
 127       '#default_value' => $this->options['expose']['items_per_page_options'],
 128       '#states' => [
 129         'invisible' => [
 130           'input[name="pager_options[expose][items_per_page]"]' => ['checked' => FALSE],
 131         ],
 132       ],
 133     ];
 134
 135     $form['expose']['items_per_page_options_all'] = [
 136       '#type' => 'checkbox',
 137       '#title' => $this->t('Allow user to display all items'),
 138       '#default_value' => $this->options['expose']['items_per_page_options_all'],
 139     ];
 140
 141     $form['expose']['items_per_page_options_all_label'] = [
 142       '#type' => 'textfield',
 143       '#title' => $this->t('All items label'),
 144       '#default_value' => $this->options['expose']['items_per_page_options_all_label'],
 145       '#states' => [
 146         'invisible' => [
 147           'input[name="pager_options[expose][items_per_page_options_all]"]' => ['checked' => FALSE],
 148         ],
 149       ],
 150     ];
 151
 152     $form['expose']['offset'] = [
 153       '#type' => 'checkbox',
 154       '#title' => $this->t('Allow user to specify number of items skipped from beginning of this view.'),
 155       '#default_value' => $this->options['expose']['offset'],
 156     ];
 157
 158     $form['expose']['offset_label'] = [
 159       '#type' => 'textfield',
 160       '#title' => $this->t('Offset label'),
 161       '#required' => TRUE,
 162       '#default_value' => $this->options['expose']['offset_label'],
 163       '#states' => [
 164         'invisible' => [
 165           'input[name="pager_options[expose][offset]"]' => ['checked' => FALSE],
 166         ],
 167       ],
 168     ];
 169   }
 170
 171   public function validateOptionsForm(&$form, FormStateInterface $form_state) {
 172     // Only accept integer values.
 173     $error = FALSE;
 174     $exposed_options = $form_state->getValue(['pager_options', 'expose', 'items_per_page_options']);
 175     if (strpos($exposed_options, '.') !== FALSE) {
 176       $error = TRUE;
 177     }
 178     $options = explode(',', $exposed_options);
 179     if (!$error && is_array($options)) {
 180       foreach ($options as $option) {
 181         if (!is_numeric($option) || intval($option) == 0) {
 182           $error = TRUE;
 183         }
 184       }
 185     }
 186     else {
 187       $error = TRUE;
 188     }
 189     if ($error) {
 190       $form_state->setErrorByName('pager_options][expose][items_per_page_options', $this->t('Insert a list of integer numeric values separated by commas: e.g: 10, 20, 50, 100'));
 191     }
 192
 193     // Make sure that the items_per_page is part of the expose settings.
 194     if (!$form_state->isValueEmpty(['pager_options', 'expose', 'items_per_page']) && !$form_state->isValueEmpty(['pager_options', 'items_per_page'])) {
 195       $items_per_page = $form_state->getValue(['pager_options', 'items_per_page']);
 196       if (array_search($items_per_page, $options) === FALSE) {
 197         $form_state->setErrorByName('pager_options][expose][items_per_page_options', $this->t("The <em>Exposed items per page</em> field's options must include the value from the <em>Items per page</em> field (@items_per_page).",
 198           ['@items_per_page' => $items_per_page])
 199         );
 200       }
 201     }
 202   }
 203
 204   public function query() {
 205     if ($this->itemsPerPageExposed()) {
 206       $query = $this->view->getRequest()->query;
 207       $items_per_page = $query->get('items_per_page');
 208       if ($items_per_page > 0) {
 209         $this->options['items_per_page'] = $items_per_page;
 210       }
 211       elseif ($items_per_page == 'All' && $this->options['expose']['items_per_page_options_all']) {
 212         $this->options['items_per_page'] = 0;
 213       }
 214     }
 215     if ($this->isOffsetExposed()) {
 216       $query = $this->view->getRequest()->query;
 217       $offset = $query->get('offset');
 218       if (isset($offset) && $offset >= 0) {
 219         $this->options['offset'] = $offset;
 220       }
 221     }
 222
 223     $limit = $this->options['items_per_page'];
 224     $offset = $this->current_page * $this->options['items_per_page'] + $this->options['offset'];
 225     if (!empty($this->options['total_pages'])) {
 226       if ($this->current_page >= $this->options['total_pages']) {
 227         $limit = $this->options['items_per_page'];
 228         $offset = $this->options['total_pages'] * $this->options['items_per_page'];
 229       }
 230     }
 231
 232     $this->view->query->setLimit($limit);
 233     $this->view->query->setOffset($offset);
 234   }
 235
 236
 237   /**
 238    * Set the current page.
 239    *
 240    * @param $number
 241    *   If provided, the page number will be set to this. If NOT provided,
 242    *   the page number will be set from the global page array.
 243    */
 244   public function setCurrentPage($number = NULL) {
 245     if (isset($number)) {
 246       $this->current_page = max(0, $number);
 247       return;
 248     }
 249
 250     // If the current page number was not specified, extract it from the global
 251     // page array.
 252     global $pager_page_array;
 253
 254     if (empty($pager_page_array)) {
 255       $pager_page_array = [];
 256     }
 257
 258     // Fill in missing values in the global page array, in case the global page
 259     // array hasn't been initialized before.
 260     $page = $this->view->getRequest()->query->get('page');
 261     $page = isset($page) ? explode(',', $page) : [];
 262
 263     for ($i = 0; $i <= $this->options['id'] || $i < count($pager_page_array); $i++) {
 264       $pager_page_array[$i] = empty($page[$i]) ? 0 : $page[$i];
 265     }
 266
 267     // Don't allow the number to be less than zero.
 268     $this->current_page = max(0, intval($pager_page_array[$this->options['id']]));
 269   }
 270
 271   public function getPagerTotal() {
 272     if ($items_per_page = intval($this->getItemsPerPage())) {
 273       return ceil($this->total_items / $items_per_page);
 274     }
 275     else {
 276       return 1;
 277     }
 278   }
 279
 280   /**
 281    * Update global paging info.
 282    *
 283    * This is called after the count query has been run to set the total
 284    * items available and to update the current page if the requested
 285    * page is out of range.
 286    */
 287   public function updatePageInfo() {
 288     if (!empty($this->options['total_pages'])) {
 289       if (($this->options['total_pages'] * $this->options['items_per_page']) < $this->total_items) {
 290         $this->total_items = $this->options['total_pages'] * $this->options['items_per_page'];
 291       }
 292     }
 293
 294     // Don't set pager settings for items per page = 0.
 295     $items_per_page = $this->getItemsPerPage();
 296     if (!empty($items_per_page)) {
 297       // Dump information about what we already know into the globals.
 298       global $pager_page_array, $pager_total, $pager_total_items, $pager_limits;
 299       // Set the limit.
 300       $pager_limits[$this->options['id']] = $this->options['items_per_page'];
 301       // Set the item count for the pager.
 302       $pager_total_items[$this->options['id']] = $this->total_items;
 303       // Calculate and set the count of available pages.
 304       $pager_total[$this->options['id']] = $this->getPagerTotal();
 305
 306       // See if the requested page was within range:
 307       if ($this->current_page >= $pager_total[$this->options['id']]) {
 308         // Pages are numbered from 0 so if there are 10 pages, the last page is 9.
 309         $this->setCurrentPage($pager_total[$this->options['id']] - 1);
 310       }
 311
 312       // Put this number in to guarantee that we do not generate notices when the pager
 313       // goes to look for it later.
 314       $pager_page_array[$this->options['id']] = $this->current_page;
 315     }
 316   }
 317
 318   public function usesExposed() {
 319     return $this->itemsPerPageExposed() || $this->isOffsetExposed();
 320   }
 321
 322   protected function itemsPerPageExposed() {
 323     return !empty($this->options['expose']['items_per_page']);
 324   }
 325
 326   protected function isOffsetExposed() {
 327     return !empty($this->options['expose']['offset']);
 328   }
 329
 330   public function exposedFormAlter(&$form, FormStateInterface $form_state) {
 331     if ($this->itemsPerPageExposed()) {
 332       $options = explode(',', $this->options['expose']['items_per_page_options']);
 333       $sanitized_options = [];
 334       if (is_array($options)) {
 335         foreach ($options as $option) {
 336           $sanitized_options[intval($option)] = intval($option);
 337         }
 338         if (!empty($this->options['expose']['items_per_page_options_all']) && !empty($this->options['expose']['items_per_page_options_all_label'])) {
 339           $sanitized_options['All'] = $this->options['expose']['items_per_page_options_all_label'];
 340         }
 341         $form['items_per_page'] = [
 342           '#type' => 'select',
 343           '#title' => $this->options['expose']['items_per_page_label'],
 344           '#options' => $sanitized_options,
 345           '#default_value' => $this->getItemsPerPage(),
 346         ];
 347       }
 348     }
 349
 350     if ($this->isOffsetExposed()) {
 351       $form['offset'] = [
 352         '#type' => 'textfield',
 353         '#size' => 10,
 354         '#maxlength' => 10,
 355         '#title' => $this->options['expose']['offset_label'],
 356         '#default_value' => $this->getOffset(),
 357       ];
 358     }
 359   }
 360
 361   public function exposedFormValidate(&$form, FormStateInterface $form_state) {
 362     if (!$form_state->isValueEmpty('offset') && trim($form_state->getValue('offset'))) {
 363       if (!is_numeric($form_state->getValue('offset')) || $form_state->getValue('offset') < 0) {
 364         $form_state->setErrorByName('offset', $this->t('Offset must be a number greater than or equal to 0.'));
 365       }
 366     }
 367   }
 368
 369   /**
 370    * {@inheritdoc}
 371    */
 372   public function getCacheMaxAge() {
 373     return Cache::PERMANENT;
 374   }
 375
 376   /**
 377    * {@inheritdoc}
 378    */
 379   public function getCacheContexts() {
 380     // The rendered link needs to play well with any other query parameter used
 381     // on the page, like other pagers and exposed filter.
 382     return ['url.query_args'];
 383   }
 384
 385   /**
 386    * {@inheritdoc}
 387    */
 388   public function getCacheTags() {
 389     return [];
 390   }
 391
 392 }