sambuc/Pico-Search
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Don't manipulate $pages directly

Browse Source 
Makes a Twig filter called apply_search available, which can be used in
templates to
filter the pages array on demand. Because of that, we can stop mutating
the pages array, which other extensions and themes may rely on.
This commit is contained in:
pontus.horn
2020-01-22 22:10:25 +01:00
parent b539f8e359
commit ba5fabdfdc
2 changed files with 62 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
40-PicoSearch.php
View File

@@ -73,54 +73,52 @@ class PicoSearch extends AbstractPicoPlugin
}
/**
* If accessing search results, filter the $pages array to pages matching the search terms.
* Filter the input array to pages matching the search terms
* and sort them by relevance.
*
* @see Pico::getPages()
* @see Pico::getCurrentPage()
* @see Pico::getPreviousPage()
* @see Pico::getNextPage()
* @param array &$pages data of all known pages
* @param array &$currentPage data of the page being served
* @param array &$previousPage data of the previous page
* @param array &$nextPage data of the next page
* @return void
* @param array $pages data of all known pages
* @return array filtered and sorted pages
*/
public function onPagesLoaded(&$pages, &$currentPage, &$previousPage, &$nextPage)
public function applySearch($pages)
{
if ($currentPage && isset($this->search_area) || isset($this->search_terms)) {
if (isset($this->search_area)) {
$pages = array_filter($pages, function ($page) {
return substr($page['id'], 0, strlen($this->search_area)) === $this->search_area;
});
}
if (!isset($this->search_area) && !isset($this->search_terms)) {
return array();
}
$pico = $this->getPico();
$excludes = $pico->getConfig('search_excludes');
if (!empty($excludes)) {
foreach ($excludes as $exclude_path) {
unset($pages[$exclude_path]);
}
}
if (isset($this->search_area)) {
$pages = array_filter($pages, function ($page) {
return substr($page['id'], 0, strlen($this->search_area)) === $this->search_area;
});
}
if (isset($this->search_terms)) {
$pages = array_map(function ($page) {
$page['search_rank'] = $this->getSearchRankForPage($page);
return $page;
}, $pages);
$pages = array_filter($pages, function ($page) {
return $page['search_rank'] > 0;
});
uasort($pages, function ($a, $b) {
if ($a['search_rank'] == $b['search_rank']) {
return 0;
}
return $a['search_rank'] > $b['search_rank'] ? -1 : 1;
});
$pico = $this->getPico();
$excludes = $pico->getConfig('search_excludes');
if (!empty($excludes)) {
foreach ($excludes as $exclude_path) {
unset($pages[$exclude_path]);
}
}
if (isset($this->search_terms)) {
$pages = array_map(function ($page) {
$page['search_rank'] = $this->getSearchRankForPage($page);
return $page;
}, $pages);
$pages = array_filter($pages, function ($page) {
return $page['search_rank'] > 0;
});
uasort($pages, function ($a, $b) {
if ($a['search_rank'] == $b['search_rank']) {
return 0;
}
return $a['search_rank'] > $b['search_rank'] ? -1 : 1;
});
}
return $pages;
}
public function getSearchRankForPage($page) {
@@ -176,4 +174,8 @@ class PicoSearch extends AbstractPicoPlugin
public function onPageRendering(&$twig, &$twigVariables, &$templateName) {
$twigVariables['search_terms'] = $this->search_terms;
}
public function onTwigRegistration() {
$this->getPico()->getTwig()->addFilter(new \Twig\TwigFilter('apply_search', [$this, 'applySearch']));
}
}