pager.inc 12.4 KB
Newer Older
Dries's avatar
Dries committed
1 2
<?php

3
/**
4 5
 * @file
 * Functions to aid in presenting database results as a set of pages.
6
 */
7

8
use Drupal\Component\Utility\UrlHelper;
9

10 11 12
/**
 * Returns the current page being requested for display within a pager.
 *
13 14
 * @param int $element
 *   (optional) An integer to distinguish between multiple pagers on one page.
15
 *
16 17 18 19 20 21 22 23 24
 * @return int
 *   The number of the current requested page, within the pager represented by
 *   $element. This is determined from the URL query parameter
 *   \Drupal::request()->query->get('page'), or 0 by default. Note that this
 *   number may differ from the actual page being displayed. For example, if a
 *   search for "example text" brings up three pages of results, but a user
 *   visits search/node/example+text?page=10, this function will return 10,
 *   even though the default pager implementation adjusts for this and still
 *   displays the third page of search results at that URL.
25 26 27 28
 *
 * @see pager_default_initialize()
 */
function pager_find_page($element = 0) {
29
  $page = \Drupal::request()->query->get('page', '');
30 31 32 33 34 35 36 37
  $page_array = explode(',', $page);
  if (!isset($page_array[$element])) {
    $page_array[$element] = 0;
  }
  return (int) $page_array[$element];
}

/**
38
 * Initializes a pager.
39
 *
40 41 42
 * This function sets up the necessary global variables so that the render
 * system will correctly process #type 'pager' render arrays to output pagers
 * that correspond to the items being displayed.
43
 *
44
 * If the items being displayed result from a database query performed using
45 46
 * Drupal's database API, and if you have control over the construction of the
 * database query, you do not need to call this function directly; instead, you
47 48
 * can simply extend the query object with the 'PagerSelectExtender' extender
 * before executing it. For example:
49
 * @code
50 51
 *   $query = db_select('some_table')
 *     ->extend('Drupal\Core\Database\Query\PagerSelectExtender');
52 53 54 55 56
 * @endcode
 *
 * However, if you are using a different method for generating the items to be
 * paged through, then you should call this function in preparation.
 *
57
 * The following example shows how this function can be used in a controller
58 59 60 61 62
 * that invokes an external datastore with an SQL-like syntax:
 * @code
 *   // First find the total number of items and initialize the pager.
 *   $where = "status = 1";
 *   $total = mymodule_select("SELECT COUNT(*) FROM data " . $where)->result();
63
 *   $num_per_page = \Drupal::config('mymodule.settings')->get('num_per_page');
64 65
 *   $page = pager_default_initialize($total, $num_per_page);
 *
66 67
 *   // Next, retrieve the items for the current page and put them into a
 *   // render array.
68 69
 *   $offset = $num_per_page * $page;
 *   $result = mymodule_select("SELECT * FROM data " . $where . " LIMIT %d, %d", $offset, $num_per_page)->fetchAll();
70 71
 *   $render = [];
 *   $render[] = [
72 73
 *     '#theme' => 'mymodule_results',
 *     '#result' => $result,
74
 *   ];
75
 *
76 77 78
 *   // Finally, add the pager to the render array, and return.
 *   $render[] = ['#type' => 'pager'];
 *   return $render;
79 80
 * @endcode
 *
81
 * A second example involves a controller that invokes an external search
82 83 84 85 86 87 88 89 90 91
 * service where the total number of matching results is provided as part of
 * the returned set (so that we do not need a separate query in order to obtain
 * this information). Here, we call pager_find_page() to calculate the desired
 * offset before the search is invoked:
 * @code
 *   // Perform the query, using the requested offset from pager_find_page().
 *   // This comes from a URL parameter, so here we are assuming that the URL
 *   // parameter corresponds to an actual page of results that will exist
 *   // within the set.
 *   $page = pager_find_page();
92
 *   $num_per_page = \Drupal::config('mymodule.settings')->get('num_per_page');
93 94 95 96 97 98
 *   $offset = $num_per_page * $page;
 *   $result = mymodule_remote_search($keywords, $offset, $num_per_page);
 *
 *   // Now that we have the total number of results, initialize the pager.
 *   pager_default_initialize($result->total, $num_per_page);
 *
99 100 101
 *   // Create a render array with the search results.
 *   $render = [];
 *   $render[] = [
102 103 104
 *     '#theme' => 'search_results',
 *     '#results' => $result->data,
 *     '#type' => 'remote',
105
 *   ];
106
 *
107 108 109
 *   // Finally, add the pager to the render array, and return.
 *   $render[] = ['#type' => 'pager'];
 *   return $render;
110 111
 * @endcode
 *
112 113 114 115 116 117
 * @param int $total
 *   The total number of items to be paged.
 * @param int $limit
 *   The number of items the calling code will display per page.
 * @param int $element
 *   (optional) An integer to distinguish between multiple pagers on one page.
118
 *
119
 * @return int
120
 *   The number of the current page, within the pager represented by $element.
121 122 123 124 125
 *   This is determined from the URL query parameter
 *   \Drupal::request()->query->get('page), or 0 by default. However, if a page
 *   that does not correspond to the actual range of the result set was
 *   requested, this function will return the closest page actually within the
 *   result set.
126 127 128 129 130 131 132 133 134 135 136 137 138 139
 */
function pager_default_initialize($total, $limit, $element = 0) {
  global $pager_page_array, $pager_total, $pager_total_items, $pager_limits;

  $page = pager_find_page($element);

  // We calculate the total of pages as ceil(items / limit).
  $pager_total_items[$element] = $total;
  $pager_total[$element] = ceil($pager_total_items[$element] / $limit);
  $pager_page_array[$element] = max(0, min($page, ((int) $pager_total[$element]) - 1));
  $pager_limits[$element] = $limit;
  return $pager_page_array[$element];
}

140
/**
141
 * Compose a URL query parameter array for pager links.
142
 *
143
 * @return array
144 145
 *   A URL query parameter array that consists of all components of the current
 *   page request except for those pertaining to paging.
146
 */
147 148 149
function pager_get_query_parameters() {
  $query = &drupal_static(__FUNCTION__);
  if (!isset($query)) {
150
    $query = UrlHelper::filterQueryParameters(\Drupal::request()->query->all(), array('page'));
151
  }
152
  return $query;
153 154
}

155
/**
156 157 158
 * Prepares variables for pager templates.
 *
 * Default template: pager.html.twig.
159
 *
160
 * Menu callbacks that display paged query results should use #type => pager
161 162
 * to retrieve a pager control so that users can view other results. Format a
 * list of nearby pages with additional query results.
163
 *
164
 * @param array $variables
165
 *   An associative array containing:
166 167 168 169
 *   - pager: A render element containing:
 *     - #tags: An array of labels for the controls in the pager.
 *     - #element: An optional integer to distinguish between multiple pagers on
 *       one page.
170 171
 *     - #parameters: An associative array of query string parameters to append
 *       to the pager links.
172
 *     - #route_parameters: An associative array of the route parameters.
173
 *     - #quantity: The number of pages in the list.
174
 */
175
function template_preprocess_pager(&$variables) {
176 177 178
  $element = $variables['pager']['#element'];
  $parameters = $variables['pager']['#parameters'];
  $quantity = $variables['pager']['#quantity'];
179
  $route_name = $variables['pager']['#route_name'];
180
  $route_parameters = isset($variables['pager']['#route_parameters']) ? $variables['pager']['#route_parameters'] : [];
181 182
  global $pager_page_array, $pager_total;

183 184 185 186 187
  // Nothing to do if there is only one page.
  if ($pager_total[$element] <= 1) {
    return;
  }

188
  $tags = $variables['pager']['#tags'];
189

190 191 192
  // Calculate various markers within this pager piece:
  // Middle is used to "center" pages around the current page.
  $pager_middle = ceil($quantity / 2);
193
  // current is the page we are currently paged to.
194
  $pager_current = $pager_page_array[$element] + 1;
195
  // first is the first page listed by this pager piece (re quantity).
196
  $pager_first = $pager_current - $pager_middle + 1;
197
  // last is the last page listed by this pager piece (re quantity).
198
  $pager_last = $pager_current + $quantity - $pager_middle;
199
  // max is the maximum page number.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  $pager_max = $pager_total[$element];
  // End of marker calculations.

  // Prepare for generation loop.
  $i = $pager_first;
  if ($pager_last > $pager_max) {
    // Adjust "center" if at end of query.
    $i = $i + ($pager_max - $pager_last);
    $pager_last = $pager_max;
  }
  if ($i <= 0) {
    // Adjust "center" if at start of query.
    $pager_last = $pager_last + (1 - $i);
    $i = 1;
  }
  // End of generation loop preparation.

217 218
  // Create the "first" and "previous" links if we are not on the first page.
  if ($pager_page_array[$element] > 0) {
219 220 221
    $items['first'] = array();
    $options = array(
      'query' => pager_query_add_page($parameters, $element, 0),
222
    );
223
    $items['first']['href'] = \Drupal::url($route_name, $route_parameters, $options);
224 225 226
    if (isset($tags[0])) {
      $items['first']['text'] = $tags[0];
    }
227

228 229 230
    $items['previous'] = array();
    $options = array(
      'query' => pager_query_add_page($parameters, $element, $pager_page_array[$element] - 1),
231
    );
232
    $items['previous']['href'] = \Drupal::url($route_name, $route_parameters, $options);
233 234 235
    if (isset($tags[1])) {
      $items['previous']['text'] = $tags[1];
    }
236
  }
237

238 239 240 241
  if ($i != $pager_max) {
    // Add an ellipsis if there are further previous pages.
    if ($i > 1) {
      $variables['ellipses']['previous'] = TRUE;
242
    }
243 244 245 246
    // Now generate the actual pager piece.
    for (; $i <= $pager_last && $i <= $pager_max; $i++) {
      $options = array(
        'query' => pager_query_add_page($parameters, $element, $i - 1),
247
      );
248
      $items['pages'][$i]['href'] = \Drupal::url($route_name, $route_parameters, $options);
249 250
      if ($i == $pager_current) {
        $variables['current'] = $i;
251 252
      }
    }
253
    // Add an ellipsis if there are further next pages.
254
    if ($i < $pager_max + 1) {
255
      $variables['ellipses']['next'] = TRUE;
256
    }
257 258 259 260 261 262 263 264
  }

  // Create the "next" and "last" links if we are not on the last page.
  if ($pager_page_array[$element] < ($pager_max - 1)) {
    $items['next'] = array();
    $options = array(
      'query' => pager_query_add_page($parameters, $element, $pager_page_array[$element] + 1),
    );
265
    $items['next']['href'] = \Drupal::url($route_name, $route_parameters, $options);
266 267
    if (isset($tags[3])) {
      $items['next']['text'] = $tags[3];
268
    }
269

270 271 272
    $items['last'] = array();
    $options = array(
      'query' => pager_query_add_page($parameters, $element, $pager_max - 1),
273
    );
274
    $items['last']['href'] = \Drupal::url($route_name, $route_parameters, $options);
275 276 277
    if (isset($tags[4])) {
      $items['last']['text'] = $tags[4];
    }
Dries's avatar
Dries committed
278
  }
279 280

  $variables['items'] = $items;
281

282 283
  // The rendered link needs to play well with any other query parameter used
  // on the page, like exposed filters, so for the cacheability all query
284 285
  // parameters matter.
  $variables['#cache']['contexts'][] = 'url.query_args';
Dries's avatar
Dries committed
286
}
287 288

/**
289
 * Gets the URL query parameter array of a pager link.
290
 *
291 292 293 294 295 296 297 298 299
 * Adds to or adjusts the 'page' URL query parameter so that if you follow the
 * link, you'll get page $index for pager $element on the page.
 *
 * The 'page' URL query parameter is a comma-delimited string, where each value
 * is the target content page for the corresponding pager $element. For
 * instance, if we have 5 pagers on a single page, and we want to have a link
 * to a page that should display the 6th content page for the 3rd pager, and
 * the 1st content page for all the other pagers, then the URL query will look
 * like this: ?page=0,0,5,0,0 (page numbering starts at zero).
300
 *
301
 * @param array $query
302 303
 *   An associative array of URL query parameters to add to.
 * @param int $element
304
 *   An integer to distinguish between multiple pagers on one page.
305
 * @param int $index
306
 *   The index of the target page, for the given element, in the pager array.
307
 *
308 309
 * @return array
 *   The altered $query parameter array.
310
 */
311 312 313
function pager_query_add_page(array $query, $element, $index) {
  global $pager_page_array;

314 315 316 317 318 319 320
  // Build the 'page' query parameter. This is built based on the current
  // page of each pager element (or NULL if the pager is not set), with the
  // exception of the requested page index for the current element.
  $max_element = max(array_keys($pager_page_array));
  $element_pages = [];
  for ($i = 0; $i <= $max_element; $i++) {
    $element_pages[] = ($i == $element) ? $index : (isset($pager_page_array[$i]) ? $pager_page_array[$i] : NULL);
321
  }
322 323
  $query['page'] = implode(',', $element_pages);

324
  // Merge the query parameters passed to this function with the parameters
325 326
  // from the current request. In case of collision, the parameters passed into
  // this function take precedence.
327 328
  if ($current_request_query = pager_get_query_parameters()) {
    $query = array_merge($current_request_query, $query);
Dries's avatar
Dries committed
329
  }
330
  return $query;
Dries's avatar
Dries committed
331
}