Mercurial > defr > drupal > core

annotate includes/pager.inc @ 1:c1f4ac30525a 6.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Drupal 6.0
author Franck Deroche <webmaster@defr.org>
date Tue, 23 Dec 2008 14:28:28 +0100
parents
children
rev   line source
webmaster@1 1 <?php
webmaster@1 2 // $Id: pager.inc,v 1.63 2007/12/06 09:58:30 goba Exp $
webmaster@1 3
webmaster@1 4 /**
webmaster@1 5 * @file
webmaster@1 6 * Functions to aid in presenting database results as a set of pages.
webmaster@1 7 */
webmaster@1 8
webmaster@1 9 /**
webmaster@1 10 * Perform a paged database query.
webmaster@1 11 *
webmaster@1 12 * Use this function when doing select queries you wish to be able to page. The
webmaster@1 13 * pager uses LIMIT-based queries to fetch only the records required to render a
webmaster@1 14 * certain page. However, it has to learn the total number of records returned
webmaster@1 15 * by the query to compute the number of pages (the number of records / records
webmaster@1 16 * per page). This is done by inserting "COUNT(*)" in the original query. For
webmaster@1 17 * example, the query "SELECT nid, type FROM node WHERE status = '1' ORDER BY
webmaster@1 18 * sticky DESC, created DESC" would be rewritten to read "SELECT COUNT(*) FROM
webmaster@1 19 * node WHERE status = '1' ORDER BY sticky DESC, created DESC". Rewriting the
webmaster@1 20 * query is accomplished using a regular expression.
webmaster@1 21 *
webmaster@1 22 * Unfortunately, the rewrite rule does not always work as intended for queries
webmaster@1 23 * that already have a "COUNT(*)" or a "GROUP BY" clause, and possibly for
webmaster@1 24 * other complex queries. In those cases, you can optionally pass a query that
webmaster@1 25 * will be used to count the records.
webmaster@1 26 *
webmaster@1 27 * For example, if you want to page the query "SELECT COUNT(*), TYPE FROM node
webmaster@1 28 * GROUP BY TYPE", pager_query() would invoke the incorrect query "SELECT
webmaster@1 29 * COUNT(*) FROM node GROUP BY TYPE". So instead, you should pass "SELECT
webmaster@1 30 * COUNT(DISTINCT(TYPE)) FROM node" as the optional $count_query parameter.
webmaster@1 31 *
webmaster@1 32 * @param $query
webmaster@1 33 * The SQL query that needs paging.
webmaster@1 34 * @param $limit
webmaster@1 35 * The number of query results to display per page.
webmaster@1 36 * @param $element
webmaster@1 37 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 38 * @param $count_query
webmaster@1 39 * An SQL query used to count matching records.
webmaster@1 40 * @param ...
webmaster@1 41 * A variable number of arguments which are substituted into the query (and
webmaster@1 42 * the count query) using printf() syntax. Instead of a variable number of
webmaster@1 43 * query arguments, you may also pass a single array containing the query
webmaster@1 44 * arguments.
webmaster@1 45 * @return
webmaster@1 46 * A database query result resource, or FALSE if the query was not executed
webmaster@1 47 * correctly.
webmaster@1 48 *
webmaster@1 49 * @ingroup database
webmaster@1 50 */
webmaster@1 51 function pager_query($query, $limit = 10, $element = 0, $count_query = NULL) {
webmaster@1 52 global $pager_page_array, $pager_total, $pager_total_items;
webmaster@1 53 $page = isset($_GET['page']) ? $_GET['page'] : '';
webmaster@1 54
webmaster@1 55 // Substitute in query arguments.
webmaster@1 56 $args = func_get_args();
webmaster@1 57 $args = array_slice($args, 4);
webmaster@1 58 // Alternative syntax for '...'
webmaster@1 59 if (isset($args[0]) && is_array($args[0])) {
webmaster@1 60 $args = $args[0];
webmaster@1 61 }
webmaster@1 62
webmaster@1 63 // Construct a count query if none was given.
webmaster@1 64 if (!isset($count_query)) {
webmaster@1 65 $count_query = preg_replace(array('/SELECT.*?FROM /As', '/ORDER BY .*/'), array('SELECT COUNT(*) FROM ', ''), $query);
webmaster@1 66 }
webmaster@1 67
webmaster@1 68 // Convert comma-separated $page to an array, used by other functions.
webmaster@1 69 $pager_page_array = explode(',', $page);
webmaster@1 70
webmaster@1 71 // We calculate the total of pages as ceil(items / limit).
webmaster@1 72 $pager_total_items[$element] = db_result(db_query($count_query, $args));
webmaster@1 73 $pager_total[$element] = ceil($pager_total_items[$element] / $limit);
webmaster@1 74 $pager_page_array[$element] = max(0, min((int)$pager_page_array[$element], ((int)$pager_total[$element]) - 1));
webmaster@1 75 return db_query_range($query, $args, $pager_page_array[$element] * $limit, $limit);
webmaster@1 76 }
webmaster@1 77
webmaster@1 78 /**
webmaster@1 79 * Compose a query string to append to pager requests.
webmaster@1 80 *
webmaster@1 81 * @return
webmaster@1 82 * A query string that consists of all components of the current page request
webmaster@1 83 * except for those pertaining to paging.
webmaster@1 84 */
webmaster@1 85 function pager_get_querystring() {
webmaster@1 86 static $string = NULL;
webmaster@1 87 if (!isset($string)) {
webmaster@1 88 $string = drupal_query_string_encode($_REQUEST, array_merge(array('q', 'page'), array_keys($_COOKIE)));
webmaster@1 89 }
webmaster@1 90 return $string;
webmaster@1 91 }
webmaster@1 92
webmaster@1 93 /**
webmaster@1 94 * Format a query pager.
webmaster@1 95 *
webmaster@1 96 * Menu callbacks that display paged query results should call theme('pager') to
webmaster@1 97 * retrieve a pager control so that users can view other results.
webmaster@1 98 * Format a list of nearby pages with additional query results.
webmaster@1 99 *
webmaster@1 100 * @param $tags
webmaster@1 101 * An array of labels for the controls in the pager.
webmaster@1 102 * @param $limit
webmaster@1 103 * The number of query results to display per page.
webmaster@1 104 * @param $element
webmaster@1 105 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 106 * @param $parameters
webmaster@1 107 * An associative array of query string parameters to append to the pager links.
webmaster@1 108 * @param $quantity
webmaster@1 109 * The number of pages in the list.
webmaster@1 110 * @return
webmaster@1 111 * An HTML string that generates the query pager.
webmaster@1 112 *
webmaster@1 113 * @ingroup themeable
webmaster@1 114 */
webmaster@1 115 function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array(), $quantity = 9) {
webmaster@1 116 global $pager_page_array, $pager_total;
webmaster@1 117
webmaster@1 118 // Calculate various markers within this pager piece:
webmaster@1 119 // Middle is used to "center" pages around the current page.
webmaster@1 120 $pager_middle = ceil($quantity / 2);
webmaster@1 121 // current is the page we are currently paged to
webmaster@1 122 $pager_current = $pager_page_array[$element] + 1;
webmaster@1 123 // first is the first page listed by this pager piece (re quantity)
webmaster@1 124 $pager_first = $pager_current - $pager_middle + 1;
webmaster@1 125 // last is the last page listed by this pager piece (re quantity)
webmaster@1 126 $pager_last = $pager_current + $quantity - $pager_middle;
webmaster@1 127 // max is the maximum page number
webmaster@1 128 $pager_max = $pager_total[$element];
webmaster@1 129 // End of marker calculations.
webmaster@1 130
webmaster@1 131 // Prepare for generation loop.
webmaster@1 132 $i = $pager_first;
webmaster@1 133 if ($pager_last > $pager_max) {
webmaster@1 134 // Adjust "center" if at end of query.
webmaster@1 135 $i = $i + ($pager_max - $pager_last);
webmaster@1 136 $pager_last = $pager_max;
webmaster@1 137 }
webmaster@1 138 if ($i <= 0) {
webmaster@1 139 // Adjust "center" if at start of query.
webmaster@1 140 $pager_last = $pager_last + (1 - $i);
webmaster@1 141 $i = 1;
webmaster@1 142 }
webmaster@1 143 // End of generation loop preparation.
webmaster@1 144
webmaster@1 145 $li_first = theme('pager_first', (isset($tags[0]) ? $tags[0] : t('« first')), $limit, $element, $parameters);
webmaster@1 146 $li_previous = theme('pager_previous', (isset($tags[1]) ? $tags[1] : t('‹ previous')), $limit, $element, 1, $parameters);
webmaster@1 147 $li_next = theme('pager_next', (isset($tags[3]) ? $tags[3] : t('next ›')), $limit, $element, 1, $parameters);
webmaster@1 148 $li_last = theme('pager_last', (isset($tags[4]) ? $tags[4] : t('last »')), $limit, $element, $parameters);
webmaster@1 149
webmaster@1 150 if ($pager_total[$element] > 1) {
webmaster@1 151 if ($li_first) {
webmaster@1 152 $items[] = array(
webmaster@1 153 'class' => 'pager-first',
webmaster@1 154 'data' => $li_first,
webmaster@1 155 );
webmaster@1 156 }
webmaster@1 157 if ($li_previous) {
webmaster@1 158 $items[] = array(
webmaster@1 159 'class' => 'pager-previous',
webmaster@1 160 'data' => $li_previous,
webmaster@1 161 );
webmaster@1 162 }
webmaster@1 163
webmaster@1 164 // When there is more than one page, create the pager list.
webmaster@1 165 if ($i != $pager_max) {
webmaster@1 166 if ($i > 1) {
webmaster@1 167 $items[] = array(
webmaster@1 168 'class' => 'pager-ellipsis',
webmaster@1 169 'data' => '…',
webmaster@1 170 );
webmaster@1 171 }
webmaster@1 172 // Now generate the actual pager piece.
webmaster@1 173 for (; $i <= $pager_last && $i <= $pager_max; $i++) {
webmaster@1 174 if ($i < $pager_current) {
webmaster@1 175 $items[] = array(
webmaster@1 176 'class' => 'pager-item',
webmaster@1 177 'data' => theme('pager_previous', $i, $limit, $element, ($pager_current - $i), $parameters),
webmaster@1 178 );
webmaster@1 179 }
webmaster@1 180 if ($i == $pager_current) {
webmaster@1 181 $items[] = array(
webmaster@1 182 'class' => 'pager-current',
webmaster@1 183 'data' => $i,
webmaster@1 184 );
webmaster@1 185 }
webmaster@1 186 if ($i > $pager_current) {
webmaster@1 187 $items[] = array(
webmaster@1 188 'class' => 'pager-item',
webmaster@1 189 'data' => theme('pager_next', $i, $limit, $element, ($i - $pager_current), $parameters),
webmaster@1 190 );
webmaster@1 191 }
webmaster@1 192 }
webmaster@1 193 if ($i < $pager_max) {
webmaster@1 194 $items[] = array(
webmaster@1 195 'class' => 'pager-ellipsis',
webmaster@1 196 'data' => '…',
webmaster@1 197 );
webmaster@1 198 }
webmaster@1 199 }
webmaster@1 200 // End generation.
webmaster@1 201 if ($li_next) {
webmaster@1 202 $items[] = array(
webmaster@1 203 'class' => 'pager-next',
webmaster@1 204 'data' => $li_next,
webmaster@1 205 );
webmaster@1 206 }
webmaster@1 207 if ($li_last) {
webmaster@1 208 $items[] = array(
webmaster@1 209 'class' => 'pager-last',
webmaster@1 210 'data' => $li_last,
webmaster@1 211 );
webmaster@1 212 }
webmaster@1 213 return theme('item_list', $items, NULL, 'ul', array('class' => 'pager'));
webmaster@1 214 }
webmaster@1 215 }
webmaster@1 216
webmaster@1 217
webmaster@1 218 /**
webmaster@1 219 * @name Pager pieces
webmaster@1 220 * @{
webmaster@1 221 * Use these pieces to construct your own custom pagers in your theme. Note that
webmaster@1 222 * you should NOT modify this file to customize your pager.
webmaster@1 223 */
webmaster@1 224
webmaster@1 225 /**
webmaster@1 226 * Format a "first page" link.
webmaster@1 227 *
webmaster@1 228 * @param $text
webmaster@1 229 * The name (or image) of the link.
webmaster@1 230 * @param $limit
webmaster@1 231 * The number of query results to display per page.
webmaster@1 232 * @param $element
webmaster@1 233 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 234 * @param $parameters
webmaster@1 235 * An associative array of query string parameters to append to the pager links.
webmaster@1 236 * @return
webmaster@1 237 * An HTML string that generates this piece of the query pager.
webmaster@1 238 *
webmaster@1 239 * @ingroup themeable
webmaster@1 240 */
webmaster@1 241 function theme_pager_first($text, $limit, $element = 0, $parameters = array()) {
webmaster@1 242 global $pager_page_array;
webmaster@1 243 $output = '';
webmaster@1 244
webmaster@1 245 // If we are anywhere but the first page
webmaster@1 246 if ($pager_page_array[$element] > 0) {
webmaster@1 247 $output = theme('pager_link', $text, pager_load_array(0, $element, $pager_page_array), $element, $parameters);
webmaster@1 248 }
webmaster@1 249
webmaster@1 250 return $output;
webmaster@1 251 }
webmaster@1 252
webmaster@1 253 /**
webmaster@1 254 * Format a "previous page" link.
webmaster@1 255 *
webmaster@1 256 * @param $text
webmaster@1 257 * The name (or image) of the link.
webmaster@1 258 * @param $limit
webmaster@1 259 * The number of query results to display per page.
webmaster@1 260 * @param $element
webmaster@1 261 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 262 * @param $interval
webmaster@1 263 * The number of pages to move backward when the link is clicked.
webmaster@1 264 * @param $parameters
webmaster@1 265 * An associative array of query string parameters to append to the pager links.
webmaster@1 266 * @return
webmaster@1 267 * An HTML string that generates this piece of the query pager.
webmaster@1 268 *
webmaster@1 269 * @ingroup themeable
webmaster@1 270 */
webmaster@1 271 function theme_pager_previous($text, $limit, $element = 0, $interval = 1, $parameters = array()) {
webmaster@1 272 global $pager_page_array;
webmaster@1 273 $output = '';
webmaster@1 274
webmaster@1 275 // If we are anywhere but the first page
webmaster@1 276 if ($pager_page_array[$element] > 0) {
webmaster@1 277 $page_new = pager_load_array($pager_page_array[$element] - $interval, $element, $pager_page_array);
webmaster@1 278
webmaster@1 279 // If the previous page is the first page, mark the link as such.
webmaster@1 280 if ($page_new[$element] == 0) {
webmaster@1 281 $output = theme('pager_first', $text, $limit, $element, $parameters);
webmaster@1 282 }
webmaster@1 283 // The previous page is not the first page.
webmaster@1 284 else {
webmaster@1 285 $output = theme('pager_link', $text, $page_new, $element, $parameters);
webmaster@1 286 }
webmaster@1 287 }
webmaster@1 288
webmaster@1 289 return $output;
webmaster@1 290 }
webmaster@1 291
webmaster@1 292 /**
webmaster@1 293 * Format a "next page" link.
webmaster@1 294 *
webmaster@1 295 * @param $text
webmaster@1 296 * The name (or image) of the link.
webmaster@1 297 * @param $limit
webmaster@1 298 * The number of query results to display per page.
webmaster@1 299 * @param $element
webmaster@1 300 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 301 * @param $interval
webmaster@1 302 * The number of pages to move forward when the link is clicked.
webmaster@1 303 * @param $parameters
webmaster@1 304 * An associative array of query string parameters to append to the pager links.
webmaster@1 305 * @return
webmaster@1 306 * An HTML string that generates this piece of the query pager.
webmaster@1 307 *
webmaster@1 308 * @ingroup themeable
webmaster@1 309 */
webmaster@1 310 function theme_pager_next($text, $limit, $element = 0, $interval = 1, $parameters = array()) {
webmaster@1 311 global $pager_page_array, $pager_total;
webmaster@1 312 $output = '';
webmaster@1 313
webmaster@1 314 // If we are anywhere but the last page
webmaster@1 315 if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
webmaster@1 316 $page_new = pager_load_array($pager_page_array[$element] + $interval, $element, $pager_page_array);
webmaster@1 317 // If the next page is the last page, mark the link as such.
webmaster@1 318 if ($page_new[$element] == ($pager_total[$element] - 1)) {
webmaster@1 319 $output = theme('pager_last', $text, $limit, $element, $parameters);
webmaster@1 320 }
webmaster@1 321 // The next page is not the last page.
webmaster@1 322 else {
webmaster@1 323 $output = theme('pager_link', $text, $page_new, $element, $parameters);
webmaster@1 324 }
webmaster@1 325 }
webmaster@1 326
webmaster@1 327 return $output;
webmaster@1 328 }
webmaster@1 329
webmaster@1 330 /**
webmaster@1 331 * Format a "last page" link.
webmaster@1 332 *
webmaster@1 333 * @param $text
webmaster@1 334 * The name (or image) of the link.
webmaster@1 335 * @param $limit
webmaster@1 336 * The number of query results to display per page.
webmaster@1 337 * @param $element
webmaster@1 338 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 339 * @param $parameters
webmaster@1 340 * An associative array of query string parameters to append to the pager links.
webmaster@1 341 * @return
webmaster@1 342 * An HTML string that generates this piece of the query pager.
webmaster@1 343 *
webmaster@1 344 * @ingroup themeable
webmaster@1 345 */
webmaster@1 346 function theme_pager_last($text, $limit, $element = 0, $parameters = array()) {
webmaster@1 347 global $pager_page_array, $pager_total;
webmaster@1 348 $output = '';
webmaster@1 349
webmaster@1 350 // If we are anywhere but the last page
webmaster@1 351 if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
webmaster@1 352 $output = theme('pager_link', $text, pager_load_array($pager_total[$element] - 1, $element, $pager_page_array), $element, $parameters);
webmaster@1 353 }
webmaster@1 354
webmaster@1 355 return $output;
webmaster@1 356 }
webmaster@1 357
webmaster@1 358
webmaster@1 359 /**
webmaster@1 360 * Format a link to a specific query result page.
webmaster@1 361 *
webmaster@1 362 * @param $page_new
webmaster@1 363 * The first result to display on the linked page.
webmaster@1 364 * @param $element
webmaster@1 365 * An optional integer to distinguish between multiple pagers on one page.
webmaster@1 366 * @param $parameters
webmaster@1 367 * An associative array of query string parameters to append to the pager link.
webmaster@1 368 * @param $attributes
webmaster@1 369 * An associative array of HTML attributes to apply to a pager anchor tag.
webmaster@1 370 * @return
webmaster@1 371 * An HTML string that generates the link.
webmaster@1 372 *
webmaster@1 373 * @ingroup themeable
webmaster@1 374 */
webmaster@1 375 function theme_pager_link($text, $page_new, $element, $parameters = array(), $attributes = array()) {
webmaster@1 376 $page = isset($_GET['page']) ? $_GET['page'] : '';
webmaster@1 377 if ($new_page = implode(',', pager_load_array($page_new[$element], $element, explode(',', $page)))) {
webmaster@1 378 $parameters['page'] = $new_page;
webmaster@1 379 }
webmaster@1 380
webmaster@1 381 $query = array();
webmaster@1 382 if (count($parameters)) {
webmaster@1 383 $query[] = drupal_query_string_encode($parameters, array());
webmaster@1 384 }
webmaster@1 385 $querystring = pager_get_querystring();
webmaster@1 386 if ($querystring != '') {
webmaster@1 387 $query[] = $querystring;
webmaster@1 388 }
webmaster@1 389
webmaster@1 390 // Set each pager link title
webmaster@1 391 if (!isset($attributes['title'])) {
webmaster@1 392 static $titles = NULL;
webmaster@1 393 if (!isset($titles)) {
webmaster@1 394 $titles = array(
webmaster@1 395 t('« first') => t('Go to first page'),
webmaster@1 396 t('‹ previous') => t('Go to previous page'),
webmaster@1 397 t('next ›') => t('Go to next page'),
webmaster@1 398 t('last »') => t('Go to last page'),
webmaster@1 399 );
webmaster@1 400 }
webmaster@1 401 if (isset($titles[$text])) {
webmaster@1 402 $attributes['title'] = $titles[$text];
webmaster@1 403 }
webmaster@1 404 else if (is_numeric($text)) {
webmaster@1 405 $attributes['title'] = t('Go to page @number', array('@number' => $text));
webmaster@1 406 }
webmaster@1 407 }
webmaster@1 408
webmaster@1 409 return l($text, $_GET['q'], array('attributes' => $attributes, 'query' => count($query) ? implode('&', $query) : NULL));
webmaster@1 410 }
webmaster@1 411
webmaster@1 412 /**
webmaster@1 413 * @} End of "Pager pieces".
webmaster@1 414 */
webmaster@1 415
webmaster@1 416 /**
webmaster@1 417 * Helper function
webmaster@1 418 *
webmaster@1 419 * Copies $old_array to $new_array and sets $new_array[$element] = $value
webmaster@1 420 * Fills in $new_array[0 .. $element - 1] = 0
webmaster@1 421 */
webmaster@1 422 function pager_load_array($value, $element, $old_array) {
webmaster@1 423 $new_array = $old_array;
webmaster@1 424 // Look for empty elements.
webmaster@1 425 for ($i = 0; $i < $element; $i++) {
webmaster@1 426 if (!$new_array[$i]) {
webmaster@1 427 // Load found empty element with 0.
webmaster@1 428 $new_array[$i] = 0;
webmaster@1 429 }
webmaster@1 430 }
webmaster@1 431 // Update the changed element.
webmaster@1 432 $new_array[$element] = (int)$value;
webmaster@1 433 return $new_array;
webmaster@1 434 }