pager.inc 14.5 KB
Newer Older
Dries's avatar
Dries committed
1
<?php
2
// $Id$
Dries's avatar
Dries committed
3

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

/**
10 11
 * Perform a paged database query.
 *
12 13 14
 * Use this function when doing select queries you wish to be able to page. The
 * pager uses LIMIT-based queries to fetch only the records required to render a
 * certain page. However, it has to learn the total number of records returned
15 16 17 18 19 20
 * by the query to compute the number of pages (the number of records / records
 * per page). This is done by inserting "COUNT(*)" in the original query. For
 * example, the query "SELECT nid, type FROM node WHERE status = '1' ORDER BY
 * sticky DESC, created DESC" would be rewritten to read "SELECT COUNT(*) FROM
 * node WHERE status = '1' ORDER BY sticky DESC, created DESC". Rewriting the
 * query is accomplished using a regular expression.
21
 *
22
 * Unfortunately, the rewrite rule does not always work as intended for queries
23
 * that already have a "COUNT(*)" or a "GROUP BY" clause, and possibly for
24 25
 * other complex queries. In those cases, you can optionally pass a query that
 * will be used to count the records.
26
 *
27 28
 * For example, if you want to page the query "SELECT COUNT(*), TYPE FROM node
 * GROUP BY TYPE", pager_query() would invoke the incorrect query "SELECT
29 30
 * COUNT(*) FROM node GROUP BY TYPE". So instead, you should pass "SELECT
 * COUNT(DISTINCT(TYPE)) FROM node" as the optional $count_query parameter.
31
 *
32 33 34 35 36 37 38 39
 * @param $query
 *   The SQL query that needs paging.
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
 * @param $count_query
 *   An SQL query used to count matching records.
40 41
 * @param ...
 *   A variable number of arguments which are substituted into the query (and
42 43 44
 *   the count query) using printf() syntax. Instead of a variable number of
 *   query arguments, you may also pass a single array containing the query
 *   arguments.
45 46 47
 * @return
 *   A database query result resource, or FALSE if the query was not executed
 *   correctly.
48 49
 *
 * @ingroup database
50
 */
51
function pager_query($query, $limit = 10, $element = 0, $count_query = NULL) {
52
  global $pager_page_array, $pager_total, $pager_total_items;
53
  $page = isset($_GET['page']) ? $_GET['page'] : '';
54

55 56 57
  // Substitute in query arguments.
  $args = func_get_args();
  $args = array_slice($args, 4);
58
  // Alternative syntax for '...'
59
  if (isset($args[0]) && is_array($args[0])) {
60 61
    $args = $args[0];
  }
62

63
  // Construct a count query if none was given.
64
  if (!isset($count_query)) {
65
    $count_query = preg_replace(array('/SELECT.*?FROM/As', '/ORDER BY .*/'), array('SELECT COUNT(*) FROM', ''), $query);
66 67
  }

68 69
  // Convert comma-separated $page to an array, used by other functions.
  $pager_page_array = explode(',', $page);
70

71
  // We calculate the total of pages as ceil(items / limit).
72
  if (count($args)) {
73 74
    $pager_total_items[$element] = db_result(db_query($count_query, $args));
    $pager_total[$element] = ceil($pager_total_items[$element] / $limit);
75
    $pager_page_array[$element] = max(0, min((int)$pager_page_array[$element], ((int)$pager_total[$element]) - 1));
76
    return db_query_range($query, $args, $pager_page_array[$element] * $limit, $limit);
77 78
  }
  else {
79 80
    $pager_total_items[$element] = db_result(db_query($count_query));
    $pager_total[$element] = ceil($pager_total_items[$element] / $limit);
81
    $pager_page_array[$element] = max(0, min((int)$pager_page_array[$element], ((int)$pager_total[$element]) - 1));
82
    return db_query_range($query, $pager_page_array[$element] * $limit, $limit);
83
  }
84 85
}

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/**
 * Compose a query string to append to pager requests.
 *
 * @return
 *   A query string that consists of all components of the current page request
 *   except for those pertaining to paging.
 */
function pager_get_querystring() {
  static $string = NULL;
  if (!isset($string)) {
    $string = drupal_query_string_encode($_REQUEST, array_merge(array('q', 'page'), array_keys($_COOKIE)));
  }
  return $string;
}

101
/**
102 103 104 105 106 107 108 109 110 111 112
 * Format a query pager.
 *
 * Menu callbacks that display paged query results should call theme('pager') to
 * retrieve a pager control so that users can view other results.
 *
 * @param $tags
 *   An array of labels for the controls in the pager.
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
113
 * @param $parameters
114 115 116
 *   An associative array of query string parameters to append to the pager links.
 * @return
 *   An HTML string that generates the query pager.
117 118
 *
 * @ingroup themeable
119
 */
120
function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array()) {
Dries's avatar
Dries committed
121
  global $pager_total;
122 123
  $output = '';

124
  if ($pager_total[$element] > 1) {
125
    $output .= '<div id="pager">';
126 127
    $output .= theme('pager_first', ($tags[0] ? $tags[0] : t('« first')), $limit, $element, $parameters);
    $output .= theme('pager_previous', ($tags[1] ? $tags[1] : t('‹ previous')), $limit, $element, 1, $parameters);
128
    $output .= theme('pager_list', $limit, $element, ($tags[2] ? $tags[2] : 9 ), '', $parameters);
129 130
    $output .= theme('pager_next', ($tags[3] ? $tags[3] : t('next ›')), $limit, $element, 1, $parameters);
    $output .= theme('pager_last', ($tags[4] ? $tags[4] : t('last »')), $limit, $element, $parameters);
131
    $output .= '</div>';
Dries's avatar
Dries committed
132

Dries's avatar
Dries committed
133 134
    return $output;
  }
Dries's avatar
Dries committed
135
}
136

137
/**
138
 * @name Pager pieces
139
 * @{
140 141
 * Use these pieces to construct your own custom pagers in your theme. Note that
 * you should NOT modify this file to customize your pager.
142
 */
Dries's avatar
Dries committed
143

144
/**
145
 * Format a "first page" link.
146
 *
147 148 149 150 151 152
 * @param $text
 *   The name (or image) of the link.
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
153
 * @param $parameters
154 155 156
 *   An associative array of query string parameters to append to the pager links.
 * @return
 *   An HTML string that generates this piece of the query pager.
157 158
 *
 * @ingroup themeable
159
 */
160
function theme_pager_first($text, $limit, $element = 0, $parameters = array()) {
161
  global $pager_page_array;
162
  $output = '';
Dries's avatar
Dries committed
163

164 165
  // If we are anywhere but the first page
  if ($pager_page_array[$element] > 0) {
166
    $output = theme('pager_link', $text, pager_load_array(0, $element, $pager_page_array), $element, $parameters, array('class' => 'pager-first'));
Dries's avatar
Dries committed
167
  }
168

169
  return $output;
Dries's avatar
Dries committed
170 171
}

172
/**
173
 * Format a "previous page" link.
174
 *
175 176 177 178 179 180 181 182
 * @param $text
 *   The name (or image) of the link.
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
 * @param $interval
 *   The number of pages to move backward when the link is clicked.
183
 * @param $parameters
184 185 186
 *   An associative array of query string parameters to append to the pager links.
 * @return
 *   An HTML string that generates this piece of the query pager.
187 188
 *
 * @ingroup themeable
189
 */
190
function theme_pager_previous($text, $limit, $element = 0, $interval = 1, $parameters = array()) {
191
  global $pager_page_array;
192 193
  $output = '';

194 195 196
  // If we are anywhere but the first page
  if ($pager_page_array[$element] > 0) {
    $page_new = pager_load_array($pager_page_array[$element] - $interval, $element, $pager_page_array);
197

198 199
    // If the previous page is the first page, mark the link as such.
    if ($page_new[$element] == 0) {
200
      $output = theme('pager_first', $text, $limit, $element, $parameters);
201 202 203
    }
    // The previous page is not the first page.
    else {
204
      $output = theme('pager_link', $text, $page_new, $element, $parameters, array('class' => 'pager-previous'));
205
    }
Dries's avatar
Dries committed
206
  }
207

208
  return $output;
Dries's avatar
Dries committed
209 210
}

211
/**
212
 * Format a "next page" link.
213
 *
214 215 216 217 218 219 220 221
 * @param $text
 *   The name (or image) of the link.
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
 * @param $interval
 *   The number of pages to move forward when the link is clicked.
222
 * @param $parameters
223 224 225
 *   An associative array of query string parameters to append to the pager links.
 * @return
 *   An HTML string that generates this piece of the query pager.
226 227
 *
 * @ingroup themeable
228
 */
229
function theme_pager_next($text, $limit, $element = 0, $interval = 1, $parameters = array()) {
230
  global $pager_page_array, $pager_total;
231 232
  $output = '';

233 234 235 236 237
  // If we are anywhere but the last page
  if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
    $page_new = pager_load_array($pager_page_array[$element] + $interval, $element, $pager_page_array);
    // If the next page is the last page, mark the link as such.
    if ($page_new[$element] == ($pager_total[$element] - 1)) {
238
      $output = theme('pager_last', $text, $limit, $element, $parameters);
239 240 241
    }
    // The next page is not the last page.
    else {
242
      $output = theme('pager_link', $text, $page_new, $element, $parameters, array('class' => 'pager-next'));
243
    }
244
  }
245

246
  return $output;
Dries's avatar
Dries committed
247 248
}

249
/**
250
 * Format a "last page" link.
251
 *
252 253 254 255 256 257
 * @param $text
 *   The name (or image) of the link.
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
258
 * @param $parameters
259 260 261
 *   An associative array of query string parameters to append to the pager links.
 * @return
 *   An HTML string that generates this piece of the query pager.
262 263
 *
 * @ingroup themeable
264
 */
265
function theme_pager_last($text, $limit, $element = 0, $parameters = array()) {
266
  global $pager_page_array, $pager_total;
267
  $output = '';
Dries's avatar
Dries committed
268

269 270
  // If we are anywhere but the last page
  if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
271
    $output = theme('pager_link', $text, pager_load_array($pager_total[$element] - 1, $element, $pager_page_array), $element, $parameters, array('class' => 'pager-last'));
272
  }
273

274
  return $output;
Dries's avatar
Dries committed
275 276
}

277
/**
278
 * Format a list of nearby pages with additional query results.
279
 *
280 281 282 283 284 285 286 287
 * @param $limit
 *   The number of query results to display per page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
 * @param $quantity
 *   The number of pages in the list.
 * @param $text
 *   A string of text to display before the page list.
288
 * @param $parameters
289 290 291
 *   An associative array of query string parameters to append to the pager links.
 * @return
 *   An HTML string that generates this piece of the query pager.
292 293
 *
 * @ingroup themeable
294
 */
295
function theme_pager_list($limit, $element = 0, $quantity = 5, $text = '', $parameters = array()) {
296
  global $pager_page_array, $pager_total;
Dries's avatar
Dries committed
297

298
  $output = '<span class="pager-list">';
299 300
  // Calculate various markers within this pager piece:
  // Middle is used to "center" pages around the current page.
301
  $pager_middle = ceil($quantity / 2);
Dries's avatar
Dries committed
302
  // current is the page we are currently paged to
303
  $pager_current = $pager_page_array[$element] + 1;
Dries's avatar
Dries committed
304
  // first is the first page listed by this pager piece (re quantity)
305
  $pager_first = $pager_current - $pager_middle + 1;
Dries's avatar
Dries committed
306
  // last is the last page listed by this pager piece (re quantity)
307 308 309
  $pager_last = $pager_current + $quantity - $pager_middle;
  // max is the maximum page number
  $pager_max = $pager_total[$element];
310
  // End of marker calculations.
Dries's avatar
Dries committed
311

312
  // Prepare for generation loop.
313
  $i = $pager_first;
Dries's avatar
Dries committed
314
  if ($pager_last > $pager_max) {
315
    // Adjust "center" if at end of query.
316
    $i = $i + ($pager_max - $pager_last);
Dries's avatar
Dries committed
317 318 319
    $pager_last = $pager_max;
  }
  if ($i <= 0) {
320
    // Adjust "center" if at start of query.
Dries's avatar
Dries committed
321 322 323
    $pager_last = $pager_last + (1 - $i);
    $i = 1;
  }
324
  // End of generation loop preparation.
Dries's avatar
Dries committed
325

326
  // When there is more than one page, create the pager list.
327
  if ($i != $pager_max) {
328
    $output .= $text;
329
    if ($i > 1) {
330
      $output .= '<span class="pager-ellipsis">…</span>';
Dries's avatar
Dries committed
331
    }
332

333
    // Now generate the actual pager piece.
334 335
    for (; $i <= $pager_last && $i <= $pager_max; $i++) {
      if ($i < $pager_current) {
336
        $output .= theme('pager_previous', $i, $limit, $element, ($pager_current - $i), $parameters);
337 338
      }
      if ($i == $pager_current) {
339
        $output .= '<strong class="pager-current">'. $i .'</strong>';
340 341
      }
      if ($i > $pager_current) {
342
        $output .= theme('pager_next', $i, $limit, $element, ($i - $pager_current), $parameters);
343
      }
Dries's avatar
Dries committed
344 345
    }

346
    if ($i < $pager_max) {
347
      $output .= '<span class="pager-ellipsis">…</span>';
348
    }
Dries's avatar
Dries committed
349
  }
350
  $output .= '</span>';
Dries's avatar
Dries committed
351 352 353 354

  return $output;
}

355 356 357
/**
 * Format a link to a specific query result page.
 *
358
 * @param $page_new
359 360 361
 *   The first result to display on the linked page.
 * @param $element
 *   An optional integer to distinguish between multiple pagers on one page.
362
 * @param $parameters
363
 *   An associative array of query string parameters to append to the pager link.
364 365
 * @param $attributes
 *   An associative array of HTML attributes to apply to a pager anchor tag.
366 367 368
 * @return
 *   An HTML string that generates the link.
 */
369
function theme_pager_link($text, $page_new, $element, $parameters = array(), $attributes = array()) {
370 371
  $page = isset($_GET['page']) ? $_GET['page'] : '';
  if ($new_page = implode(',', pager_load_array($page_new[$element], $element, explode(',', $page)))) {
372
    $parameters['page'] = $new_page;
373
  }
374

375
  $query = array();
376 377 378 379 380 381
  if (count($parameters)) {
    $query[] = drupal_query_string_encode($parameters, array());
  }
  $querystring = pager_get_querystring();
  if ($querystring != '') {
    $query[] = $querystring;
Dries's avatar
Dries committed
382
  }
383

384
  // Set each pager link title
385
  if (!isset($attributes['title'])) {
386
    static $titles = NULL;
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
    if (!isset($titles)) {
      $titles = array(
        t('« first') => t('Go to first page'),
        t('‹ previous') => t('Go to previous page'),
        t('next ›') => t('Go to next page'),
        t('last »') => t('Go to last page'),
      );
    }
    if (isset($titles[$text])) {
      $attributes['title'] = $titles[$text];
    }
    else if (is_numeric($text)) {
      $attributes['title'] = t('Go to page %number', array('%number' => $text));
    }
  }
402

403
  return l($text, $_GET['q'], $attributes, count($query) ? implode('&', $query) : NULL);
Dries's avatar
Dries committed
404
}
405

406 407 408
/**
 * @} End of "Pager pieces".
 */
Dries's avatar
Dries committed
409

410 411 412 413 414 415
/**
 * Helper function
 *
 * Copies $old_array to $new_array and sets $new_array[$element] = $value
 * Fills in $new_array[0 .. $element - 1] = 0
 */
Dries's avatar
Dries committed
416 417
function pager_load_array($value, $element, $old_array) {
  $new_array = $old_array;
418
  // Look for empty elements.
Dries's avatar
Dries committed
419 420
  for ($i = 0; $i < $element; $i++) {
    if (!$new_array[$i]) {
421
      // Load found empty element with 0.
Dries's avatar
Dries committed
422 423 424
      $new_array[$i] = 0;
    }
  }
425
  // Update the changed element.
Dries's avatar
Dries committed
426 427 428 429
  $new_array[$element] = (int)$value;
  return $new_array;
}

430