summaryrefslogtreecommitdiff
path: root/includes/pager.inc
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2007-05-01 06:53:03 +0000
committerDries Buytaert <dries@buytaert.net>2007-05-01 06:53:03 +0000
commit2a65f86bf02f7bc685587e71764c918d10cdc043 (patch)
tree7fb3ef6436297110950add74fe0a7d09168be545 /includes/pager.inc
parent7d4f2836ba303c3ac2657eb019419c04471fb034 (diff)
downloadbrdo-2a65f86bf02f7bc685587e71764c918d10cdc043.tar.gz
brdo-2a65f86bf02f7bc685587e71764c918d10cdc043.tar.bz2
- Patch #135931 by EclipseGc: semantic update for core pager.
Diffstat (limited to 'includes/pager.inc')
-rw-r--r--includes/pager.inc200
1 files changed, 105 insertions, 95 deletions
diff --git a/includes/pager.inc b/includes/pager.inc
index cabbe9e8b..2e8b81bbd 100644
--- a/includes/pager.inc
+++ b/includes/pager.inc
@@ -95,6 +95,7 @@ function pager_get_querystring() {
*
* Menu callbacks that display paged query results should call theme('pager') to
* retrieve a pager control so that users can view other results.
+ * Format a list of nearby pages with additional query results.
*
* @param $tags
* An array of labels for the controls in the pager.
@@ -104,28 +105,116 @@ function pager_get_querystring() {
* An optional integer to distinguish between multiple pagers on one page.
* @param $parameters
* An associative array of query string parameters to append to the pager links.
+ * @param $quantity
+ * The number of pages in the list.
* @return
* An HTML string that generates the query pager.
*
* @ingroup themeable
*/
-function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array()) {
- global $pager_total;
- $output = '';
+function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array(), $quantity = 9) {
+ global $pager_page_array, $pager_total;
+
+ // Calculate various markers within this pager piece:
+ // Middle is used to "center" pages around the current page.
+ $pager_middle = ceil($quantity / 2);
+ // current is the page we are currently paged to
+ $pager_current = $pager_page_array[$element] + 1;
+ // first is the first page listed by this pager piece (re quantity)
+ $pager_first = $pager_current - $pager_middle + 1;
+ // last is the last page listed by this pager piece (re quantity)
+ $pager_last = $pager_current + $quantity - $pager_middle;
+ // max is the maximum page number
+ $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.
+
+ $li_first = theme('pager_first', ($tags[0] ? $tags[0] : t('« first')), $limit, $element, $parameters);
+ $li_previous = theme('pager_previous', ($tags[1] ? $tags[1] : t('‹ previous')), $limit, $element, 1, $parameters);
+ $li_next = theme('pager_next', ($tags[3] ? $tags[3] : t('next ›')), $limit, $element, 1, $parameters);
+ $li_last = theme('pager_last', ($tags[4] ? $tags[4] : t('last »')), $limit, $element, $parameters);
if ($pager_total[$element] > 1) {
- $output .= '<div class="pager">';
- $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);
- $output .= theme('pager_list', $limit, $element, ($tags[2] ? $tags[2] : 9 ), '', $parameters);
- $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);
- $output .= '</div>';
-
- return $output;
+ if ($li_first) {
+ $items[] = array(
+ 'class' => 'pager-first',
+ 'data' => $li_first,
+ );
+ }
+ if ($li_previous) {
+ $items[] = array(
+ 'class' => 'pager-previous',
+ 'data' => $li_previous,
+ );
+ }
+
+ // When there is more than one page, create the pager list.
+ if ($i != $pager_max) {
+ if ($i > 1) {
+ $items[] = array(
+ 'class' => 'pager-ellipsis',
+ 'data' => '…',
+ );
+ }
+ // Now generate the actual pager piece.
+ for (; $i <= $pager_last && $i <= $pager_max; $i++) {
+ if ($i < $pager_current) {
+ $items[] = array(
+ 'class' => 'pager-item',
+ 'data' => theme('pager_previous', $i, $limit, $element, ($pager_current - $i), $parameters),
+ );
+ }
+ if ($i == $pager_current) {
+ $items[] = array(
+ 'class' => 'pager-current',
+ 'data' => $i,
+ );
+ }
+ if ($i > $pager_current) {
+ $items[] = array(
+ 'class' => 'pager-item',
+ 'data' => theme('pager_next', $i, $limit, $element, ($i - $pager_current), $parameters),
+ );
+ }
+ }
+ if ($i < $pager_max) {
+ $items[] = array(
+ 'class' => 'pager-ellipsis',
+ 'data' => '…',
+ );
+ }
+ }
+ // End generation.
+ if ($li_next) {
+ $items[] = array(
+ 'class' => 'pager-next',
+ 'data' => $li_next,
+ );
+ }
+ if ($li_last) {
+ $items[] = array(
+ 'class' => 'pager-last',
+ 'data' => $li_last,
+ );
+ }
+ return theme('item_list', $items, NULL, 'ul', array('class' => 'pager'));
}
}
+
/**
* @name Pager pieces
* @{
@@ -155,7 +244,7 @@ function theme_pager_first($text, $limit, $element = 0, $parameters = array()) {
// If we are anywhere but the first page
if ($pager_page_array[$element] > 0) {
- $output = theme('pager_link', $text, pager_load_array(0, $element, $pager_page_array), $element, $parameters, array('class' => 'pager-first'));
+ $output = theme('pager_link', $text, pager_load_array(0, $element, $pager_page_array), $element, $parameters);
}
return $output;
@@ -193,7 +282,7 @@ function theme_pager_previous($text, $limit, $element = 0, $interval = 1, $param
}
// The previous page is not the first page.
else {
- $output = theme('pager_link', $text, $page_new, $element, $parameters, array('class' => 'pager-previous'));
+ $output = theme('pager_link', $text, $page_new, $element, $parameters);
}
}
@@ -231,7 +320,7 @@ function theme_pager_next($text, $limit, $element = 0, $interval = 1, $parameter
}
// The next page is not the last page.
else {
- $output = theme('pager_link', $text, $page_new, $element, $parameters, array('class' => 'pager-next'));
+ $output = theme('pager_link', $text, $page_new, $element, $parameters);
}
}
@@ -260,89 +349,12 @@ function theme_pager_last($text, $limit, $element = 0, $parameters = array()) {
// If we are anywhere but the last page
if ($pager_page_array[$element] < ($pager_total[$element] - 1)) {
- $output = theme('pager_link', $text, pager_load_array($pager_total[$element] - 1, $element, $pager_page_array), $element, $parameters, array('class' => 'pager-last'));
+ $output = theme('pager_link', $text, pager_load_array($pager_total[$element] - 1, $element, $pager_page_array), $element, $parameters);
}
return $output;
}
-/**
- * Format a list of nearby pages with additional query results.
- *
- * @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.
- * @param $parameters
- * 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.
- *
- * @ingroup themeable
- */
-function theme_pager_list($limit, $element = 0, $quantity = 5, $text = '', $parameters = array()) {
- global $pager_page_array, $pager_total;
-
- $output = '<span class="pager-list">';
- // Calculate various markers within this pager piece:
- // Middle is used to "center" pages around the current page.
- $pager_middle = ceil($quantity / 2);
- // current is the page we are currently paged to
- $pager_current = $pager_page_array[$element] + 1;
- // first is the first page listed by this pager piece (re quantity)
- $pager_first = $pager_current - $pager_middle + 1;
- // last is the last page listed by this pager piece (re quantity)
- $pager_last = $pager_current + $quantity - $pager_middle;
- // max is the maximum page number
- $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.
-
- // When there is more than one page, create the pager list.
- if ($i != $pager_max) {
- $output .= $text;
- if ($i > 1) {
- $output .= '<span class="pager-ellipsis">…</span>';
- }
-
- // Now generate the actual pager piece.
- for (; $i <= $pager_last && $i <= $pager_max; $i++) {
- if ($i < $pager_current) {
- $output .= theme('pager_previous', $i, $limit, $element, ($pager_current - $i), $parameters);
- }
- if ($i == $pager_current) {
- $output .= '<strong class="pager-current">'. $i .'</strong>';
- }
- if ($i > $pager_current) {
- $output .= theme('pager_next', $i, $limit, $element, ($i - $pager_current), $parameters);
- }
- }
-
- if ($i < $pager_max) {
- $output .= '<span class="pager-ellipsis">…</span>';
- }
- }
- $output .= '</span>';
-
- return $output;
-}
/**
* Format a link to a specific query result page.
@@ -418,5 +430,3 @@ function pager_load_array($value, $element, $old_array) {
$new_array[$element] = (int)$value;
return $new_array;
}
-
-