Skip to content

Updated pagination #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Bryan-Lund wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Updated pagination #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9d40de6
Added a check to see if there are less results than one page to remov…
Bryan-Lund Jan 17, 2017
617be86
Merge pull request #1 from bolser/feature/pagination-amends
Bryan-Lund Jan 17, 2017
f8b7cbf
Added the exclude to check regardless of other IDs being supplied
Bryan-Lund Jan 17, 2017
de68353
Spacing
Bryan-Lund Jan 17, 2017
35358c9
Merge pull request #2 from bolser/feature/adding-exclude
Bryan-Lund Jan 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions core/components/simplesearch/model/simplesearch/driver/simplesearchdriverbasic.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
require_once dirname(__FILE__) . '/simplesearchdriver.class.php';
/**
* Standard sql-based search driver for SimpleSearch
*
*
* @package simplesearch
*/
class SimpleSearchDriverBasic extends SimpleSearchDriver {
Expand Down Expand Up @@ -171,6 +171,11 @@ public function search($str,array $scriptProperties = array()) {
$c->where(array('searchable:=' => 1), xPDOQuery::SQL_AND, null, $whereGroup);
$c->where(array('deleted:=' => 0), xPDOQuery::SQL_AND, null, $whereGroup);

// If some IDs should be excluded
if (!empty($exclude)) {
$c->where(array("id:NOT IN" => explode(',', $exclude)), xPDOQuery::SQL_AND, null, $whereGroup);
}

/* restrict to either this context or specified contexts */
$ctx = !empty($this->config['contexts']) ? $this->config['contexts'] : $this->modx->context->get('key');
$f = $this->modx->getSelectColumns('modResource','modResource','',array('context_key'));
Expand Down Expand Up @@ -253,5 +258,5 @@ public function addRelevancyCondition(&$query, $options) {
}
return true;
}
}

}
164 changes: 101 additions & 63 deletions core/components/simplesearch/model/simplesearch/simplesearch.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public function getChunk($name,$properties = array()) {
if (empty($chunk)) {
$chunk = $this->modx->getObject('modChunk',array('name' => $name),true);
if ($chunk == false) return false;
}
}
$this->chunks[$name] = $chunk->getContent();
} else {
$o = $this->chunks[$name];
Expand Down Expand Up @@ -195,6 +195,11 @@ public function getPagination($searchString = '',$perPage = 10,$separator = ' |
if ($total === false) $total = $this->response['total'];
$pagination = '';

// If there are less results than the amount per page, no point showing pagination
if ($total < $perPage) {
return;
}

/* setup default properties */
$searchIndex = $this->modx->getOption('searchIndex',$this->config,'search');
$searchOffset = $this->modx->getOption('offsetIndex',$this->config,'sisea_offset');
Expand All @@ -209,78 +214,111 @@ public function getPagination($searchString = '',$perPage = 10,$separator = ' |
$searchString = isset($_REQUEST[$searchIndex]) ? $_REQUEST[$searchIndex] : '';
}

// Moved the current offset out of the loop as it doesn't change throughout the loop
$currentOffset = $this->modx->getOption($searchOffset,$_GET,0);

// Adding a variable for the current page number
$currentPageNo = ($currentOffset / $perPage) + 1;

$pageLinkCount = ceil($total / $perPage);
$pageArray = array();
$id = $this->modx->resource->get('id');
$pageLimit = $this->modx->getOption('pageLimit',$this->config,0);
$pageFirstTpl = $this->modx->getOption('pageFirstTpl',$this->config,$pageTpl);
$pageLastTpl = $this->modx->getOption('pageLastTpl',$this->config,$pageTpl);
$pagePrevTpl = $this->modx->getOption('pagePrevTpl',$this->config,$pageTpl);
$pageNextTpl = $this->modx->getOption('pageNextTpl',$this->config,$pageTpl);
$pageLimit = $this->modx->getOption('pageLimit',$this->config,0);

// Added a limit for mobile for nicer responsiveness
$mobilePageLimit = $this->modx->getOption('mobilePageLimit', $this->config, 2);

$pageFirstTpl = $this->modx->getOption('pageTpl',$this->config,$pageTpl);
$pageLastTpl = $this->modx->getOption('pageTpl',$this->config,$pageTpl);
$pagePrevTpl = $this->modx->getOption('pageTpl',$this->config,$pageTpl);
$pageNextTpl = $this->modx->getOption('pageTpl',$this->config,$pageTpl);
for ($i = 0; $i < $pageLinkCount; ++$i) {
$pageArray['separator'] = $separator;
$pageArray['classes'] = '';
$pageArray['offset'] = $i * $perPage;
$currentOffset = $this->modx->getOption($searchOffset,$_GET,0);
if ($pageLimit > 0 && $i+1 == 1 && $pageArray['offset'] != $currentOffset && !empty($pageFirstTpl)) {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $pageArray['offset'],
$searchIndex => $searchString,
));
$pageArray['text'] = 'First';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageFirstTpl,$pageArray);
if (!empty($pagePrevTpl) && ($currentOffset - $perPage) >= $perPage) {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $currentOffset - $perPage,
$searchIndex => $searchString,
));
$pageArray['text'] = '&lt;&lt;';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pagePrevTpl,$pageArray);
}
}
if (empty($pageLimit) || ($pageArray['offset'] >= $currentOffset - ($pageLimit * $perPage) && $pageArray['offset'] <= $currentOffset + ($pageLimit * $perPage))) {
if ($currentOffset == $pageArray['offset']) {
$pageArray['text'] = $i+1;
$pageArray['link'] = $i+1;
$pagination .= $this->getChunk($currentPageTpl,$pageArray);
} else {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $pageArray['offset'],
$searchIndex => $searchString,
));
$pageArray['text'] = $i+1;
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageTpl,$pageArray);
}
}
if ($pageLimit > 0 && $i+1 == $pageLinkCount && $pageArray['offset'] != $currentOffset && !empty($pageLastTpl)) {
if (!empty($pageNextTpl) && ($currentOffset + $perPage) <= $total) {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $currentOffset + $perPage,
$searchIndex => $searchString,
));
$pageArray['text'] = '&gt;&gt;';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageNextTpl,$pageArray);
}
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $pageArray['offset'],
$searchIndex => $searchString,
));
$pageArray['text'] = 'Last';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageLastTpl,$pageArray);
}

// Adding a variable for the page number in the current iteration
$pageArray['pageNo'] = ($pageArray['offset'] / $perPage) + 1;

/*
* Removed the page limit > 0 check as it was stopping the prev / first links
* from showing if there is no limit set
*/
if ($i+1 == 1 && $pageArray['offset'] != $currentOffset && !empty($pageFirstTpl)) {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $pageArray['offset'],
$searchIndex => $searchString,
));
$pageArray['text'] = 'First';
$pageArray['classes'] = 'hide-mobile';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageFirstTpl,$pageArray);
if (!empty($pagePrevTpl)) {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $currentOffset - $perPage,
$searchIndex => $searchString,
));
$pageArray['text'] = 'Prev';
$pageArray['classes'] = '';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pagePrevTpl,$pageArray);
}
}

if (empty($pageLimit)
|| ($pageArray['offset'] >= $currentOffset - ($pageLimit * $perPage)
&& $pageArray['offset'] <= $currentOffset + ($pageLimit * $perPage))) {
if ($currentOffset == $pageArray['offset']) {
$pageArray['text'] = $i+1;
$pageArray['link'] = $i+1;
$pagination .= $this->getChunk($currentPageTpl,$pageArray);
} else {
// For mobile, add a class to hide on mobile if the page number is outside the mobile limit
if ($pageArray['pageNo'] < ($currentPageNo - $mobilePageLimit)
|| $pageArray['pageNo'] > ($currentPageNo + $mobilePageLimit)) {
$pageArray['classes'] = 'hide-mobile';
}

$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $pageArray['offset'],
$searchIndex => $searchString,
));
$pageArray['text'] = $i+1;
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageTpl,$pageArray);
}
}

// Removed the page limit check for the next / last links too
if ($i+1 == $pageLinkCount && $pageArray['offset'] != $currentOffset && !empty($pageLastTpl)) {
if (!empty($pageNextTpl)) {
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $currentOffset + $perPage,
$searchIndex => $searchString,
));
$pageArray['text'] = 'Next';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageNextTpl,$pageArray);
}
$parameters = $this->modx->request->getParameters();
$parameters = array_merge($parameters,array(
$searchOffset => $pageArray['offset'],
$searchIndex => $searchString,
));
$pageArray['text'] = 'Last';
$pageArray['classes'] = 'hide-mobile';
$pageArray['link'] = $this->modx->makeUrl($id, '',$parameters,$urlScheme);
$pagination .= $this->getChunk($pageLastTpl,$pageArray);
}
if ($i < $pageLinkCount) {
$pagination .= $separator;
}
}

return trim($pagination,$separator);
}

Expand Down