webmaster@1: <?php
webmaster@1: // $Id: pager.inc,v 1.63 2007/12/06 09:58:30 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * Functions to aid in presenting database results as a set of pages.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Perform a paged database query.
webmaster@1:  *
webmaster@1:  * Use this function when doing select queries you wish to be able to page. The
webmaster@1:  * pager uses LIMIT-based queries to fetch only the records required to render a
webmaster@1:  * certain page. However, it has to learn the total number of records returned
webmaster@1:  * by the query to compute the number of pages (the number of records / records
webmaster@1:  * per page). This is done by inserting "COUNT(*)" in the original query. For
webmaster@1:  * example, the query "SELECT nid, type FROM node WHERE status = '1' ORDER BY
webmaster@1:  * sticky DESC, created DESC" would be rewritten to read "SELECT COUNT(*) FROM
webmaster@1:  * node WHERE status = '1' ORDER BY sticky DESC, created DESC". Rewriting the
webmaster@1:  * query is accomplished using a regular expression.
webmaster@1:  *
webmaster@1:  * Unfortunately, the rewrite rule does not always work as intended for queries
webmaster@1:  * that already have a "COUNT(*)" or a "GROUP BY" clause, and possibly for
webmaster@1:  * other complex queries. In those cases, you can optionally pass a query that
webmaster@1:  * will be used to count the records.
webmaster@1:  *
webmaster@1:  * For example, if you want to page the query "SELECT COUNT(*), TYPE FROM node
webmaster@1:  * GROUP BY TYPE", pager_query() would invoke the incorrect query "SELECT
webmaster@1:  * COUNT(*) FROM node GROUP BY TYPE". So instead, you should pass "SELECT
webmaster@1:  * COUNT(DISTINCT(TYPE)) FROM node" as the optional $count_query parameter.
webmaster@1:  *
webmaster@1:  * @param $query
webmaster@1:  *   The SQL query that needs paging.
webmaster@1:  * @param $limit
webmaster@1:  *   The number of query results to display per page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $count_query
webmaster@1:  *   An SQL query used to count matching records.
webmaster@1:  * @param ...
webmaster@1:  *   A variable number of arguments which are substituted into the query (and
webmaster@1:  *   the count query) using printf() syntax. Instead of a variable number of
webmaster@1:  *   query arguments, you may also pass a single array containing the query
webmaster@1:  *   arguments.
webmaster@1:  * @return
webmaster@1:  *   A database query result resource, or FALSE if the query was not executed
webmaster@1:  *   correctly.
webmaster@1:  *
webmaster@1:  * @ingroup database
webmaster@1:  */
webmaster@1: function pager_query($query, $limit = 10, $element = 0, $count_query = NULL) {
webmaster@1:   global $pager_page_array, $pager_total, $pager_total_items;
webmaster@1:   $page = isset($_GET['page']) ? $_GET['page'] : '';
webmaster@1: 
webmaster@1:   // Substitute in query arguments.
webmaster@1:   $args = func_get_args();
webmaster@1:   $args = array_slice($args, 4);
webmaster@1:   // Alternative syntax for '...'
webmaster@1:   if (isset($args[0]) && is_array($args[0])) {
webmaster@1:     $args = $args[0];
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Construct a count query if none was given.
webmaster@1:   if (!isset($count_query)) {
webmaster@1:     $count_query = preg_replace(array('/SELECT.*?FROM /As', '/ORDER BY .*/'), array('SELECT COUNT(*) FROM ', ''), $query);
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Convert comma-separated $page to an array, used by other functions.
webmaster@1:   $pager_page_array = explode(',', $page);
webmaster@1: 
webmaster@1:   // We calculate the total of pages as ceil(items / limit).
webmaster@1:   $pager_total_items[$element] = db_result(db_query($count_query, $args));
webmaster@1:   $pager_total[$element] = ceil($pager_total_items[$element] / $limit);
webmaster@1:   $pager_page_array[$element] = max(0, min((int)$pager_page_array[$element], ((int)$pager_total[$element]) - 1));
webmaster@1:   return db_query_range($query, $args, $pager_page_array[$element] * $limit, $limit);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Compose a query string to append to pager requests.
webmaster@1:  *
webmaster@1:  * @return
webmaster@1:  *   A query string that consists of all components of the current page request
webmaster@1:  *   except for those pertaining to paging.
webmaster@1:  */
webmaster@1: function pager_get_querystring() {
webmaster@1:   static $string = NULL;
webmaster@1:   if (!isset($string)) {
webmaster@1:     $string = drupal_query_string_encode($_REQUEST, array_merge(array('q', 'page'), array_keys($_COOKIE)));
webmaster@1:   }
webmaster@1:   return $string;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Format a query pager.
webmaster@1:  *
webmaster@1:  * Menu callbacks that display paged query results should call theme('pager') to
webmaster@1:  * retrieve a pager control so that users can view other results.
webmaster@1:  * Format a list of nearby pages with additional query results.
webmaster@1:  *
webmaster@1:  * @param $tags
webmaster@1:  *   An array of labels for the controls in the pager.
webmaster@1:  * @param $limit
webmaster@1:  *   The number of query results to display per page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $parameters
webmaster@1:  *   An associative array of query string parameters to append to the pager links.
webmaster@1:  * @param $quantity
webmaster@1:  *   The number of pages in the list.
webmaster@1:  * @return
webmaster@1:  *   An HTML string that generates the query pager.
webmaster@1:  *
webmaster@1:  * @ingroup themeable
webmaster@1:  */
webmaster@1: function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array(), $quantity = 9) {
webmaster@1:   global $pager_page_array, $pager_total;
webmaster@1: 
webmaster@1:   // Calculate various markers within this pager piece:
webmaster@1:   // Middle is used to "center" pages around the current page.
webmaster@1:   $pager_middle = ceil($quantity / 2);
webmaster@1:   // current is the page we are currently paged to
webmaster@1:   $pager_current = $pager_page_array[$element] + 1;
webmaster@1:   // first is the first page listed by this pager piece (re quantity)
webmaster@1:   $pager_first = $pager_current - $pager_middle + 1;
webmaster@1:   // last is the last page listed by this pager piece (re quantity)
webmaster@1:   $pager_last = $pager_current + $quantity - $pager_middle;
webmaster@1:   // max is the maximum page number
webmaster@1:   $pager_max = $pager_total[$element];
webmaster@1:   // End of marker calculations.
webmaster@1: 
webmaster@1:   // Prepare for generation loop.
webmaster@1:   $i = $pager_first;
webmaster@1:   if ($pager_last > $pager_max) {
webmaster@1:     // Adjust "center" if at end of query.
webmaster@1:     $i = $i + ($pager_max - $pager_last);
webmaster@1:     $pager_last = $pager_max;
webmaster@1:   }
webmaster@1:   if ($i <= 0) {
webmaster@1:     // Adjust "center" if at start of query.
webmaster@1:     $pager_last = $pager_last + (1 - $i);
webmaster@1:     $i = 1;
webmaster@1:   }
webmaster@1:   // End of generation loop preparation.
webmaster@1: 
webmaster@1:   $li_first = theme('pager_first', (isset($tags[0]) ? $tags[0] : t('« first')), $limit, $element, $parameters);
webmaster@1:   $li_previous = theme('pager_previous', (isset($tags[1]) ? $tags[1] : t('‹ previous')), $limit, $element, 1, $parameters);
webmaster@1:   $li_next = theme('pager_next', (isset($tags[3]) ? $tags[3] : t('next ›')), $limit, $element, 1, $parameters);
webmaster@1:   $li_last = theme('pager_last', (isset($tags[4]) ? $tags[4] : t('last »')), $limit, $element, $parameters);
webmaster@1: 
webmaster@1:   if ($pager_total[$element] > 1) {
webmaster@1:     if ($li_first) {
webmaster@1:       $items[] = array(
webmaster@1:         'class' => 'pager-first',
webmaster@1:         'data' => $li_first,
webmaster@1:       );
webmaster@1:     }
webmaster@1:     if ($li_previous) {
webmaster@1:       $items[] = array(
webmaster@1:         'class' => 'pager-previous',
webmaster@1:         'data' => $li_previous,
webmaster@1:       );
webmaster@1:     }
webmaster@1: 
webmaster@1:     // When there is more than one page, create the pager list.
webmaster@1:     if ($i != $pager_max) {
webmaster@1:       if ($i > 1) {
webmaster@1:         $items[] = array(
webmaster@1:           'class' => 'pager-ellipsis',
webmaster@1:           'data' => '…',
webmaster@1:         );
webmaster@1:       }
webmaster@1:       // Now generate the actual pager piece.
webmaster@1:       for (; $i <= $pager_last && $i <= $pager_max; $i++) {
webmaster@1:         if ($i < $pager_current) {
webmaster@1:           $items[] = array(
webmaster@1:             'class' => 'pager-item',
webmaster@1:             'data' => theme('pager_previous', $i, $limit, $element, ($pager_current - $i), $parameters),
webmaster@1:           );
webmaster@1:         }
webmaster@1:         if ($i == $pager_current) {
webmaster@1:           $items[] = array(
webmaster@1:             'class' => 'pager-current',
webmaster@1:             'data' => $i,
webmaster@1:           );
webmaster@1:         }
webmaster@1:         if ($i > $pager_current) {
webmaster@1:           $items[] = array(
webmaster@1:             'class' => 'pager-item',
webmaster@1:             'data' => theme('pager_next', $i, $limit, $element, ($i - $pager_current), $parameters),
webmaster@1:           );
webmaster@1:         }
webmaster@1:       }
webmaster@1:       if ($i < $pager_max) {
webmaster@1:         $items[] = array(
webmaster@1:           'class' => 'pager-ellipsis',
webmaster@1:           'data' => '…',
webmaster@1:         );
webmaster@1:       }
webmaster@1:     }
webmaster@1:     // End generation.
webmaster@1:     if ($li_next) {
webmaster@1:       $items[] = array(
webmaster@1:         'class' => 'pager-next',
webmaster@1:         'data' => $li_next,
webmaster@1:       );
webmaster@1:     }
webmaster@1:     if ($li_last) {
webmaster@1:       $items[] = array(
webmaster@1:         'class' => 'pager-last',
webmaster@1:         'data' => $li_last,
webmaster@1:       );
webmaster@1:     }
webmaster@1:     return theme('item_list', $items, NULL, 'ul', array('class' => 'pager'));
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @name Pager pieces
webmaster@1:  * @{
webmaster@1:  * Use these pieces to construct your own custom pagers in your theme. Note that
webmaster@1:  * you should NOT modify this file to customize your pager.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Format a "first page" link.
webmaster@1:  *
webmaster@1:  * @param $text
webmaster@1:  *   The name (or image) of the link.
webmaster@1:  * @param $limit
webmaster@1:  *   The number of query results to display per page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $parameters
webmaster@1:  *   An associative array of query string parameters to append to the pager links.
webmaster@1:  * @return
webmaster@1:  *   An HTML string that generates this piece of the query pager.
webmaster@1:  *
webmaster@1:  * @ingroup themeable
webmaster@1:  */
webmaster@1: function theme_pager_first($text, $limit, $element = 0, $parameters = array()) {
webmaster@1:   global $pager_page_array;
webmaster@1:   $output = '';
webmaster@1: 
webmaster@1:   // If we are anywhere but the first page
webmaster@1:   if ($pager_page_array[$element] > 0) {
webmaster@1:     $output = theme('pager_link', $text, pager_load_array(0, $element, $pager_page_array), $element, $parameters);
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Format a "previous page" link.
webmaster@1:  *
webmaster@1:  * @param $text
webmaster@1:  *   The name (or image) of the link.
webmaster@1:  * @param $limit
webmaster@1:  *   The number of query results to display per page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $interval
webmaster@1:  *   The number of pages to move backward when the link is clicked.
webmaster@1:  * @param $parameters
webmaster@1:  *   An associative array of query string parameters to append to the pager links.
webmaster@1:  * @return
webmaster@1:  *   An HTML string that generates this piece of the query pager.
webmaster@1:  *
webmaster@1:  * @ingroup themeable
webmaster@1:  */
webmaster@1: function theme_pager_previous($text, $limit, $element = 0, $interval = 1, $parameters = array()) {
webmaster@1:   global $pager_page_array;
webmaster@1:   $output = '';
webmaster@1: 
webmaster@1:   // If we are anywhere but the first page
webmaster@1:   if ($pager_page_array[$element] > 0) {
webmaster@1:     $page_new = pager_load_array($pager_page_array[$element] - $interval, $element, $pager_page_array);
webmaster@1: 
webmaster@1:     // If the previous page is the first page, mark the link as such.
webmaster@1:     if ($page_new[$element] == 0) {
webmaster@1:       $output = theme('pager_first', $text, $limit, $element, $parameters);
webmaster@1:     }
webmaster@1:     // The previous page is not the first page.
webmaster@1:     else {
webmaster@1:       $output = theme('pager_link', $text, $page_new, $element, $parameters);
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Format a "next page" link.
webmaster@1:  *
webmaster@1:  * @param $text
webmaster@1:  *   The name (or image) of the link.
webmaster@1:  * @param $limit
webmaster@1:  *   The number of query results to display per page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $interval
webmaster@1:  *   The number of pages to move forward when the link is clicked.
webmaster@1:  * @param $parameters
webmaster@1:  *   An associative array of query string parameters to append to the pager links.
webmaster@1:  * @return
webmaster@1:  *   An HTML string that generates this piece of the query pager.
webmaster@1:  *
webmaster@1:  * @ingroup themeable
webmaster@1:  */
webmaster@1: function theme_pager_next($text, $limit, $element = 0, $interval = 1, $parameters = array()) {
webmaster@1:   global $pager_page_array, $pager_total;
webmaster@1:   $output = '';
webmaster@1: 
webmaster@1:   // If we are anywhere but the last page
webmaster@1:   if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
webmaster@1:     $page_new = pager_load_array($pager_page_array[$element] + $interval, $element, $pager_page_array);
webmaster@1:     // If the next page is the last page, mark the link as such.
webmaster@1:     if ($page_new[$element] == ($pager_total[$element] - 1)) {
webmaster@1:       $output = theme('pager_last', $text, $limit, $element, $parameters);
webmaster@1:     }
webmaster@1:     // The next page is not the last page.
webmaster@1:     else {
webmaster@1:       $output = theme('pager_link', $text, $page_new, $element, $parameters);
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Format a "last page" link.
webmaster@1:  *
webmaster@1:  * @param $text
webmaster@1:  *   The name (or image) of the link.
webmaster@1:  * @param $limit
webmaster@1:  *   The number of query results to display per page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $parameters
webmaster@1:  *   An associative array of query string parameters to append to the pager links.
webmaster@1:  * @return
webmaster@1:  *   An HTML string that generates this piece of the query pager.
webmaster@1:  *
webmaster@1:  * @ingroup themeable
webmaster@1:  */
webmaster@1: function theme_pager_last($text, $limit, $element = 0, $parameters = array()) {
webmaster@1:   global $pager_page_array, $pager_total;
webmaster@1:   $output = '';
webmaster@1: 
webmaster@1:   // If we are anywhere but the last page
webmaster@1:   if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
webmaster@1:     $output = theme('pager_link', $text, pager_load_array($pager_total[$element] - 1, $element, $pager_page_array), $element, $parameters);
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Format a link to a specific query result page.
webmaster@1:  *
webmaster@1:  * @param $page_new
webmaster@1:  *   The first result to display on the linked page.
webmaster@1:  * @param $element
webmaster@1:  *   An optional integer to distinguish between multiple pagers on one page.
webmaster@1:  * @param $parameters
webmaster@1:  *   An associative array of query string parameters to append to the pager link.
webmaster@1:  * @param $attributes
webmaster@1:  *   An associative array of HTML attributes to apply to a pager anchor tag.
webmaster@1:  * @return
webmaster@1:  *   An HTML string that generates the link.
webmaster@1:  *
webmaster@1:  * @ingroup themeable
webmaster@1:  */
webmaster@1: function theme_pager_link($text, $page_new, $element, $parameters = array(), $attributes = array()) {
webmaster@1:   $page = isset($_GET['page']) ? $_GET['page'] : '';
webmaster@1:   if ($new_page = implode(',', pager_load_array($page_new[$element], $element, explode(',', $page)))) {
webmaster@1:     $parameters['page'] = $new_page;
webmaster@1:   }
webmaster@1: 
webmaster@1:   $query = array();
webmaster@1:   if (count($parameters)) {
webmaster@1:     $query[] = drupal_query_string_encode($parameters, array());
webmaster@1:   }
webmaster@1:   $querystring = pager_get_querystring();
webmaster@1:   if ($querystring != '') {
webmaster@1:     $query[] = $querystring;
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Set each pager link title
webmaster@1:   if (!isset($attributes['title'])) {
webmaster@1:     static $titles = NULL;
webmaster@1:     if (!isset($titles)) {
webmaster@1:       $titles = array(
webmaster@1:         t('« first') => t('Go to first page'),
webmaster@1:         t('‹ previous') => t('Go to previous page'),
webmaster@1:         t('next ›') => t('Go to next page'),
webmaster@1:         t('last »') => t('Go to last page'),
webmaster@1:       );
webmaster@1:     }
webmaster@1:     if (isset($titles[$text])) {
webmaster@1:       $attributes['title'] = $titles[$text];
webmaster@1:     }
webmaster@1:     else if (is_numeric($text)) {
webmaster@1:       $attributes['title'] = t('Go to page @number', array('@number' => $text));
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   return l($text, $_GET['q'], array('attributes' => $attributes, 'query' => count($query) ? implode('&', $query) : NULL));
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @} End of "Pager pieces".
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Helper function
webmaster@1:  *
webmaster@1:  * Copies $old_array to $new_array and sets $new_array[$element] = $value
webmaster@1:  * Fills in $new_array[0 .. $element - 1] = 0
webmaster@1:  */
webmaster@1: function pager_load_array($value, $element, $old_array) {
webmaster@1:   $new_array = $old_array;
webmaster@1:   // Look for empty elements.
webmaster@1:   for ($i = 0; $i < $element; $i++) {
webmaster@1:     if (!$new_array[$i]) {
webmaster@1:       // Load found empty element with 0.
webmaster@1:       $new_array[$i] = 0;
webmaster@1:     }
webmaster@1:   }
webmaster@1:   // Update the changed element.
webmaster@1:   $new_array[$element] = (int)$value;
webmaster@1:   return $new_array;
webmaster@1: }