Limiting Pagination to a certain number (range) of links.

Just FYI, I just changed my sample page to: http://www.liviaglobal.com/health_articles_list_test.php  

(I have to go show the client the site's progress.)  :-)

- Jeremy

Hi Jeremy,

I've taken a look at your code and have come up with this example.  Please note that this code sample has not been tested:

<?php
  $maxPages       = 5;
  $currentPage    = coalesce($health_articles_contentMetaData['page'], 1);
  $maxDisplayPage = $currentPage + $maxPages - 1;
  $totalPages     = $health_articles_contentMetaData['totalPages'];
?>


  
      
  <?php if ($health_articles_contentMetaData['prevPage']): ?>
    <li class="prev">
      <a href="<?php echo $health_articles_contentMetaData['prevPageLink'] ?>">&#8592;</a>
    </li>
  <?php endif ?>
      
              
  <?php if ($currentPage > 1): // start with ...?>
    <li><span>...</span></li>
  <?php endif ?>
  
  <?php foreach (range($currentPage, $maxDisplayPage) as $page): ?>
    <?php if ($page == $currentPage): ?>
      <li class = "current">
    <?php else: ?>
      <li>
    <?php endif ?>
    <a href="/health_articles_list.php?page=<?php echo $page; ?>"><?php echo $page; ?></a>
      </li>
  <?php endforeach ?>
  
  
  <?php if ($maxDisplayPage > $totalPages): //end with ...?>
    <li><span>...</span></li>
  <?php endif ?>
  
  <?php if ($health_articles_contentMetaData['nextPage']): ?>
    <li class="next">
      <a href="<?php echo $health_articles_contentMetaData['nextPageLink'] ?>">&#8592;</a>
    </li>
  <?php endif ?>
  

Hope this helps get you started.

Hi Jason!

That helped a ton!  Thank you very much!

It looks like the last issue I have is that even if there are less than three pages of articles, the pagination shows all five page links (even if there are only, say, 2 pages of articles).  So, two pages of articles, still shows: 1 2 3 4 5  

Similarly, once you get within five pages of the last page, I need to tell it to stop incrementing the page numbers, and simply show only the final five pages.  (Though, I did manage to get it to at least hide the right arrow and ellipsis.)  But, currently, if there are 22 pages of articles, once you hit page 18, the pagination should look like this: 18 19 20 21 22.  And, it should continue to look this way all the way up to page 22.  But, right now, when you get to page 22, it actually looks like this: 22 23 24 25 26

For an example of how it is currently functioning, you can see the very bottom pagination example on this page: http://www.liviaglobal.com/health_articles_list_test.php?page=19

I'll keep working with it.  But, if you have any ideas, I'm definitely all ears.  :-)

- Jeremy

Hi Jeremy,

Okay, I think I see the problem.  Try this change:

<?php
  $maxPages       = 5;
  $currentPage    = coalesce($health_articles_contentMetaData['page'], 1);
  $maxDisplayPage = min( ($currentPage + $maxPages - 1), $health_articles_contentMetaData['totalPages']);
  $totalPages     = $health_articles_contentMetaData['totalPages'];
?>

That should set maxDisplayPage to be the lowest of those 2 values, so you should never go beyond the totalPages number.

Hope this helps

Hey Jason!

Thank you!  That took care of the issue with too many pages being displayed.  I've made a few more modifications and I now have one last question to get this exactly where it needs to be.

Everything works perfectly, displaying a maximum of 5 page numbers (when needed).  However, is there a way to set a minimum number of pages to display as well?  This is because when you are within 5 pages of the total number of pages, displayed page numbers begin dropping out.  So, for instance, if you have 22 pages, when on page 18, you see all 5 page numbers (18, 19, 20, 21, 22).  However, when you move to page 19, you now only see 4 page numbers (19, 20, 21, 22).  This continues until, on page 22, it only displays its own number.  However, on all those 5 final pages, all five page numbers should be visible (18, 19, 20, 21, 22).

Thanks for sticking with me this long.  Any ideas on this last item?  I sure appreciate it.  I tried a few things, but nothing even remotely worked.  :-)

- Jeremy

UPDATE: I figured out how to accomplish this.  See post below...

Here's some code I'm using to achieve a similar effect.  For mine, I always want to show the start and end numbers.  I also have a prev/next links if they apply.  Finally, you can control how many numbers show in the middle.

In the HEAD:

  // load records from 'press_room'
  list($press_roomRecords, $press_roomMetaData) = getRecords(array(
    'tableName'   => 'press_room',
    'perPage'     => '5',
    'loadUploads' => true,
    'allowSearch' => true,
    'orderBy'   => 'date DESC',
    //'debugSql'           => true,
  ));

Where you want the pagination code to be shown.  Change the numbers in red to control how many additional numbers you see on either side of the current page.

<!-- START PAGINATION CODE --> 
<div class="pagelinks">
<?php  
if (@!$_GET['page']): $current_page = "1"; 
else: $current_page = $_GET['page'];    
endif;  ?> 

<?php 
$startNumber = max($current_page - 2, 1); 
$endNumber   = min($current_page + 2, $press_roomMetaData['totalPages']); 
?>

<?php if ($press_roomMetaData['prevPage']): ?>
<a href="<?php echo $press_roomMetaData['prevPageLink'] ?>"><img src="/images/arrow-left.png" border="0" /> prev</a>&nbsp;&nbsp;&nbsp;
<?php if ($startNumber > '1'): ?>
<a href="?<?php echo http_build_query(array_merge($_REQUEST, array( 'page' => '1' ))) ?> ">1</a> ...
<?php endif ?> 
<?php else: ?>
&nbsp;  
<?php endif ?>

<?php foreach (range($startNumber,$endNumber) as $page): ?>

<?php if ($page == $current_page): ?> 
 <b>[<?php echo $page; ?>]</b> 
<?php else: ?> 
 <a href="?<?php echo http_build_query(array_merge($_REQUEST, array( 'page' => $page ))) ?>"><?php echo $page; ?></a> 
<?php endif ?> 

<?php endforeach; ?> 


<?php if ($press_roomMetaData['nextPage']): ?>
<?php if ($press_roomMetaData['totalPages'] > $endNumber): ?>
... <a href="?<?php echo http_build_query(array_merge($_REQUEST, array( 'page' => $press_roomMetaData['totalPages'] ))) ?> "><?php echo $press_roomMetaData['totalPages'];?></a> 
<?php endif ?> 
&nbsp;&nbsp;&nbsp;<a href="<?php echo $press_roomMetaData['nextPageLink'] ?>">next <img src="/images/arrow-right.png" border="0" /></a>  
<?php else: ?>   
&nbsp;  
<?php endif ?>
</div>
<!-- /END PAGINATION CODE -->

BTW....many thanks to this forum and Jason from Interactive tools for the help with this code.  My original post: http://www.interactivetools.com/forum/forum-posts.php?postNum=2216522

-Kevin

Ooooh... that's clean.  Very nice!  Thanks so much for sharing Kevin!

All the best,

Jeremy

P.S.  In case anyone refers to this later, I made some improvements to my version.  (Though Kevin's is much more concise and is definitely worth looking at.)  But, in my newer version, I fixed a few bugs and I added the ability to automatically remove "..." when appropriate.  The most important improvement was that I added the ability for pagination to work even when the list is being filtered by category, date, or tags (just ensure you change the field names as needed).  This makes it much more versatile.  Of course, if you're not using any of those filters, they are just ignored.  

Here is the updated code:

<?php
  $currentPage    = coalesce($sectionNameMetaData['page'], 1);
  $maxDisplayPage = min( ($currentPage + $maxPages - 1), $sectionNameMetaData['totalPages']);
  $totalPages     = $sectionNameMetaData['totalPages'];

// Find current URL
$currentPageURL = $_SERVER['REQUEST_URI'] ;

/* CATEGORY */
// Look for word "category" in URL
$currentCategory = strpos($currentPageURL, 'category');
// If "category" not in URL...
if ($currentCategory === false) {
// Do nothing
} else {
// If "category" is in URL, get current category number
$currentCategory = $_GET['category'];
}

/* ARCHIVE */
// Look for word "date_year" in URL
$currentArchive = strpos($currentPageURL, 'date_year');
// If "category" not in URL...
if ($currentArchive === false) {
// Do nothing
} else {
// If "category" is in URL, get current category number
$currentArchive = $_GET['date_year'];
}

/* TAGS */
// Look for word "tags_keyword" in URL
$currentTag = strpos($currentPageURL, 'tags_keyword');
// If "category" not in URL...
if ($currentTag === false) {
// Do nothing
} else {
// If "category" is in URL, get current category number
$currentTag = $_GET['tags_keyword'];
$currentTag = str_replace(' ', '+', $currentTag); // Replace any spaces in tags with + symbol for URLs
}

?>


<?php if ($totalPages <= $maxPages): //run this code if less total pages than maxPages ?>
 <?php if ($sectionNameMetaData['totalPages'] > 1): ?>
   <div class="pagination">
     <ul>
          <!-- PREV PAGE -->
    <li class="prev">
           <?php if ($sectionNameMetaData['prevPage']): ?>
              <a href="<?php echo $sectionNameMetaData['prevPageLink'] ?>">&#8592;</a>
<?php else: ?>
            <?php endif ?>
          </li>
          
          <!-- PAGE NUMBERS -->
<?php foreach(range('1',$sectionNameMetaData['totalPages']) as $pageNumber): ?>
            <li <?php if($pageNumber == $sectionNameMetaData['page']): ?>class="current"<?php endif; ?>>
              <a href="
<?php // pageNumber code
                  if (strpos($currentPageURL, 'category')) {
                    echo $pageLink."?category=".$currentCategory."&page=".$pageNumber;
                } elseif (strpos($currentPageURL, 'date_year')) {
                    echo $pageLink."?date_year=".$currentArchive."&page=".$pageNumber;
                } elseif (strpos($currentPageURL, 'tags_keyword')) {
                    echo $pageLink."?tags_keyword=".$currentTag."&page=".$pageNumber;
                } else {
                    echo $pageLink."?page=".$pageNumber;
        } 
                ?>
              "><?php echo $pageNumber; ?></a>
            </li>
          <?php endforeach; ?>
          
          <!-- NEXT PAGE -->
    <li class="next">
           <?php if ($sectionNameMetaData['nextPage']): ?>
           <a href="<?php echo $sectionNameMetaData['nextPageLink'] ?>">&#8594;</a>
            <?php else: ?>
            <?php endif ?>
          </li>
     </ul>
     </div> <?php /* .pagination */ ?>
     <?php endif ?> 



<?php elseif ($currentPage >= ($totalPages - ($maxPages - 1))): //run this code if viewing one of last few pages as defined by maxPages ?>
 <?php if ($sectionNameMetaData['totalPages'] > 1): ?>
   <div class="pagination">
     <ul>
         <!-- PREV PAGE -->
    <li class="prev">
           <?php if ($sectionNameMetaData['prevPage']): ?>
              <a href="<?php echo $sectionNameMetaData['prevPageLink'] ?>">&#8592;</a>
<?php else: ?>
            <?php endif ?>
            
            <!-- PAGE NUMBERS -->
<?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // show first page number ?>
              <li>
               <a href="
<?php // Page 1 code
                    if (strpos($currentPageURL, 'category')) {
                      echo $pageLink."?category=".$currentCategory."&page=1";
                  } elseif (strpos($currentPageURL, 'date_year')) {
                      echo $pageLink."?date_year=".$currentArchive."&page=1";
                  } elseif (strpos($currentPageURL, 'tags_keyword')) {
                      echo $pageLink."?tags_keyword=".$currentTag."&page=1";
                  } else {
                      echo $pageLink."?page=1";
          } 
                  ?>
               ">1</a>
            </li>
            <?php endif ?>
                          
            <?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // start with "..." ?>
             <?php if ($totalPages == ($maxPages + 1)): ?>
              <?php // Do nothing ?>
              <?php else: ?>
               <li><span>...</span></li>
              <?php endif ?>
            <?php endif ?>
            
          </li>
<?php foreach(range(($totalPages - ($maxPages - 1)),$sectionNameMetaData['totalPages']) as $pageNumber): ?>
            <li <?php if($pageNumber == $sectionNameMetaData['page']): ?>class="current"<?php endif; ?>>
              <a href="
<?php // pageNumber code
                  if (strpos($currentPageURL, 'category')) {
                    echo $pageLink."?category=".$currentCategory."&page=".$pageNumber;
                } elseif (strpos($currentPageURL, 'date_year')) {
                    echo $pageLink."?date_year=".$currentArchive."&page=".$pageNumber;
                } elseif (strpos($currentPageURL, 'tags_keyword')) {
                    echo $pageLink."?tags_keyword=".$currentTag."&page=".$pageNumber;
                } else {
                    echo $pageLink."?page=".$pageNumber;
        } 
                ?>
     "><?php echo $pageNumber; ?></a>
            </li>
          <?php endforeach; ?>
          
          <!-- NEXT PAGE -->
    <li class="next">
           <?php if ($sectionNameMetaData['nextPage']): ?>
           <a href="<?php echo $sectionNameMetaData['nextPageLink'] ?>">&#8594;</a>
            <?php else: ?>
            <?php endif ?>
          </li>
     </ul>
     </div> <?php /* .pagination */ ?>
     <?php endif ?> 



<?php else: //run this code if more total pages than $maxPages ?>
 <?php if ($sectionNameMetaData['totalPages'] > 1): ?>
     <div class="pagination">
       <ul>
<?php if ($sectionNameMetaData['prevPage']): ?>
        
        <!-- PREV PAGE -->
          <li class="prev">
            <a href="<?php echo $sectionNameMetaData['prevPageLink'] ?>">&#8592;</a>
          </li>
        <?php endif ?>
        
    <!-- PAGE NUMBERS -->   
    <?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // show first page number ?>
      <li>
       <a href="
         <?php // Page 1 code
            if (strpos($currentPageURL, 'category')) {
              echo $pageLink."?category=".$currentCategory."&page=1";
          } elseif (strpos($currentPageURL, 'date_year')) {
              echo $pageLink."?date_year=".$currentArchive."&page=1";
          } elseif (strpos($currentPageURL, 'tags_keyword')) {
              echo $pageLink."?tags_keyword=".$currentTag."&page=1";
          } else {
              echo $pageLink."?page=1";
  } 
          ?>
        ">1</a>
      </li>
    <?php endif ?>
                  
    <?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // start with "..." ?>
     <?php if ($currentPage == "2"): ?>
       <?php // Do nothing ?>
      <?php else: ?>
       <li><span>...</span></li>
      <?php endif ?>
    <?php endif ?>
    
    
    <?php foreach (range($currentPage, $maxDisplayPage) as $page): ?>
      <?php if ($page == $currentPage): ?>
        <li class = "current">
      <?php else: ?>
        <li>
      <?php endif ?>
       <a href="
           <?php // $page code
              if (strpos($currentPageURL, 'category')) {
                echo $pageLink."?category=".$currentCategory."&page=".$page;
            } elseif (strpos($currentPageURL, 'date_year')) {
                echo $pageLink."?date_year=".$currentArchive."&page=".$page;
            } elseif (strpos($currentPageURL, 'tags_keyword')) {
                echo $pageLink."?tags_keyword=".$currentTag."&page=".$page;
            } else {
                echo $pageLink."?page=".$page;
    } 
            ?>
     "><?php echo $page; ?></a>
        </li>
    <?php endforeach ?>
    
    
    <?php if ($maxDisplayPage < $totalPages): //end with "..." ?>
     <?php if ($currentPage == ($totalPages - $maxPages)): ?>
       <?php // Do nothing ?>
<?php else: ?>
       <li><span>...</span></li>
        <?php endif ?>
<?php if ($currentPage < $totalPages): // show last page number ?>
        <li>
         <a href="
           <?php // Last page code
              if (strpos($currentPageURL, 'category')) {
                echo $pageLink."?category=".$currentCategory."&page=".$totalPages;
            } elseif (strpos($currentPageURL, 'date_year')) {
                echo $pageLink."?date_year=".$currentArchive."&page=".$totalPages;
            } elseif (strpos($currentPageURL, 'tags_keyword')) {
                echo $pageLink."?tags_keyword=".$currentTag."&page=".$totalPages;
            } else {
                echo $pageLink."?page=".$totalPages;
    } 
            ?>
          "><?php echo $totalPages; ?></a>
        </li>
      <?php endif ?>
      
      <?php if ($sectionNameMetaData['nextPage']): ?>
      
      <!-- NEXT PAGE -->
        <li class="next">
          <a href="<?php echo $sectionNameMetaData['nextPageLink'] ?>">&#8594;</a>
        </li>
      <?php endif ?>
    <?php endif ?>
    
       </ul>
       </div> <?php /* .pagination */ ?>
   <?php endif ?> 
  <?php endif ?>  


And, I also  prepped a version for use with a search results page:

<?php
  $currentPage    = coalesce($searchMeta['page'], 1);
  $maxDisplayPage = min( ($currentPage + $maxPages - 1), $searchMeta['totalPages']);
  $totalPages     = $searchMeta['totalPages'];
?>


<?php if ($totalPages <= $maxPages): //run this code if less total pages than maxPages ?>
 <?php if ($searchMeta['totalPages'] > 1): ?>
   <div class="pagination">
     <ul>
          <!-- PREV PAGE -->
    <li class="prev">
           <?php if ($searchMeta['prevPage']): ?>
              <a href="<?php echo $searchMeta['prevPageLink'] ?>">&#8592;</a>
<?php else: ?>
            <?php endif ?>
          </li>
          
          <!-- PAGE NUMBERS -->
<?php foreach(range('1',$searchMeta['totalPages']) as $pageNumber): ?>
            <li <?php if($pageNumber == $searchMeta['page']): ?>class="current"<?php endif; ?>>
              <a href="
<?php // pageNumber code
                    echo $pageLink."&page=".$pageNumber;
                ?>
              "><?php echo $pageNumber; ?></a>
            </li>
          <?php endforeach; ?>
          
          <!-- NEXT PAGE -->
    <li class="next">
           <?php if ($searchMeta['nextPage']): ?>
           <a href="<?php echo $searchMeta['nextPageLink'] ?>">&#8594;</a>
            <?php else: ?>
            <?php endif ?>
          </li>
     </ul>
     </div> <?php /* .pagination */ ?>
     <?php endif ?> 



<?php elseif ($currentPage >= ($totalPages - ($maxPages - 1))): //run this code if viewing one of last few pages as defined by maxPages ?>
 <?php if ($searchMeta['totalPages'] > 1): ?>
   <div class="pagination">
     <ul>
         <!-- PREV PAGE -->
    <li class="prev">
           <?php if ($searchMeta['prevPage']): ?>
              <a href="<?php echo $searchMeta['prevPageLink'] ?>">&#8592;</a>
<?php else: ?>
            <?php endif ?>
            
            <!-- PAGE NUMBERS -->
<?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // show first page number ?>
              <li>
               <a href="
<?php // Page 1 code
                      echo $pageLink."&page=1";
                  ?>
               ">1</a>
            </li>
            <?php endif ?>
                          
            <?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // start with "..." ?>
             <?php if ($totalPages == ($maxPages + 1)): ?>
              <?php // Do nothing ?>
              <?php else: ?>
                <li><span>...</span></li>
              <?php endif ?>
            <?php endif ?>
            
          </li>
<?php foreach(range(($totalPages - ($maxPages - 1)),$searchMeta['totalPages']) as $pageNumber): ?>
            <li <?php if($pageNumber == $searchMeta['page']): ?>class="current"<?php endif; ?>>
              <a href="
<?php // pageNumber code
                    echo $pageLink."&page=".$pageNumber;
                ?>
     "><?php echo $pageNumber; ?></a>
            </li>
          <?php endforeach; ?>
          
          <!-- NEXT PAGE -->
    <li class="next">
           <?php if ($searchMeta['nextPage']): ?>
           <a href="<?php echo $searchMeta['nextPageLink'] ?>">&#8594;</a>
            <?php else: ?>
            <?php endif ?>
          </li>
     </ul>
     </div> <?php /* .pagination */ ?>
     <?php endif ?> 



<?php else: //run this code if more total pages than $maxPages ?>
 <?php if ($searchMeta['totalPages'] > 1): ?>
     <div class="pagination">
       <ul>
<?php if ($searchMeta['prevPage']): ?>
        
        <!-- PREV PAGE -->
          <li class="prev">
            <a href="<?php echo $searchMeta['prevPageLink'] ?>">&#8592;</a>
          </li>
        <?php endif ?>
        
    <!-- PAGE NUMBERS -->   
    <?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // show first page number ?>
      <li>
       <a href="
         <?php // Page 1 code
              echo $pageLink."&page=1";
          ?>
        ">1</a>
      </li>
    <?php endif ?>
                  
    <?php if ($currentPage > 1 && $maxDisplayPage > $maxPages): // start with "..." ?>
     <?php if ($currentPage == "2"): ?>
       <?php // Do nothing ?>
      <?php else: ?>
       <li><span>...</span></li>
      <?php endif ?>
    <?php endif ?>
    
    
    <?php foreach (range($currentPage, $maxDisplayPage) as $page): ?>
      <?php if ($page == $currentPage): ?>
        <li class = "current">
      <?php else: ?>
        <li>
      <?php endif ?>
       <a href="
           <?php // $page code
                echo $pageLink."&page=".$page;
            ?>
     "><?php echo $page; ?></a>
        </li>
    <?php endforeach ?>
    
    
    <?php if ($maxDisplayPage < $totalPages): //end with "..." ?>
     <?php if ($currentPage == ($totalPages - $maxPages)): ?>
       <?php // Do nothing ?>
<?php else: ?>
          <li><span>...</span></li>
        <?php endif ?>
<?php if ($currentPage < $totalPages): // show last page number ?>
        <li>
         <a href="
           <?php // Last page code
                echo $pageLink."&page=".$totalPages;
            ?>
          "><?php echo $totalPages; ?></a>
        </li>
      <?php endif ?>
      
      <?php if ($searchMeta['nextPage']): ?>
      
      <!-- NEXT PAGE -->
        <li class="next">
          <a href="<?php echo $searchMeta['nextPageLink'] ?>">&#8594;</a>
        </li>
      <?php endif ?>
    <?php endif ?>
    
       </ul>
       </div> <?php /* .pagination */ ?>
   <?php endif ?> 
  <?php endif ?>