Using pagination to navigate through results - AlexandreToyer/opensearchserver-php-client GitHub Wiki

It is easy to create a pagination with the OssPaging class.

Let's start with the example code from our page explaining a basic query..

We will need to improve this code by adding:

a way to get the current page from the URL;
an "offset" in the query to OpenSearchServer, so it can return the appropriate documents;
display of the pagination links.

Let's write this code:

require_once(dirname(__FILE__).'/oss_api.class.php');
require_once(dirname(__FILE__).'/oss_results.class.php');
require_once(dirname(__FILE__).'/oss_paging.class.php'); //requires the OssPaging class

$oss_url = 'http://localhost:9090';
$oss_index = 'my_index';
$oss_login = 'my_login';
$oss_key = '98hg72de4f27cefbcb7a771335b98735e'
$oss_api = new OssApi($oss_url, $oss_index, $oss_login, $oss_key);


$start_offset = (isset($_GET['p'])) ? $_GET['p'] : 0;    //retrieve current page from URL, defaults to 0.
$number_by_page = 10;                                    //let's say we want 10 documents by page

$xmlResult = $oss_search->query('open')
                        ->lang('en')
                        ->template('search')
                        ->filter('date:[* TO *]')
                        ->negativeFilter('visibility:0') 
                        ->start($start_offset)           //we use 'start()' to tell OpenSearchServer what is the offset
                        ->rows($number_by_page)          //OpenSearchServer will return at most $number_by_page document by query
                        ->execute(60);

$oss_result = new OssResults($xmlResult);        
$doc_found_number = min(
          $this->oss_result->getResultRows(), 
          $this->oss_result->getResultFound() - $this->oss_result->getResultCollapsedCount() - $startOffset
       );

$results = array();
for ($i = 0; $i < $doc_found_number; $i++) {
  $pos = $oss_result->getResultRows() + $i;
  $title = $oss_result->getField($pos, 'title');
  $categories = $oss_result->getField($pos, 'category', false, false, null, true);
  $results[] = array('title' => $title, 'categories' => $categories);
}

print '<ul>';
foreach($results as $result) {
  $categories = is_array($result['categories'])) ? implode(', ', $result['categories']) : $result['categories'];
  print '<li>'.$result['title'].' - <em>'.$categories.'</em></li>';
}
print '</ul>';


$ossPaging = new OssPaging($xmlResult);                   //create an OssPaging object
if ($ossPaging->getResultPrev() < $ossPaging->getResultCurrentPage()) {
  $url = $ossPaging->getPageBaseURI() . ($ossPaging->getResultPrev());
  print '<a href="'.$url.'">Previous page</a>';           //display a link to previous page
}
if ($ossPaging->getResultNext() > $ossPaging->getResultCurrentPage()) {
  $url = $ossPaging->getPageBaseURI() . ($ossPaging->getResultNext());
  print '<a href="'.$url.'">Next page</a>';               //display a link to next page
}

This is of course a basic example of what can be done with OssPaging class. We could improve it by creating "First" and "Last" link by example, or by displaying links to several pages, before and after the current one.

This can be done by using other methods from OssPaging: getResultTotal(), getResultLow(), getResultHigh(), etc.

Using pagination to navigate through results - AlexandreToyer/opensearchserver-php-client GitHub Wiki

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️