No instant results found.
';
+ return;
+ }
+
+ let html = '';
+ results.slice(0, 5).forEach(result => {
+ html += `
+ Search results with relevance scores
+ */
+ protected $scored_results = [];
+
/**
* @return array
*/
@@ -36,6 +53,7 @@ public static function getSubscribedEvents()
return [
'onPluginsInitialized' => ['onPluginsInitialized', 0],
'onTwigTemplatePaths' => ['onTwigTemplatePaths', 0],
+ 'onTwigExtensions' => ['onTwigExtensions', 0],
'onGetPageTemplates' => ['onGetPageTemplates', 0],
];
}
@@ -63,6 +81,17 @@ public function onTwigTemplatePaths()
$this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
}
+ /**
+ * Add Twig extensions for search highlighting
+ *
+ * @return void
+ */
+ public function onTwigExtensions()
+ {
+ require_once(__DIR__ . '/twig/SimplesearchTwigExtension.php');
+ $this->grav['twig']->twig->addExtension(new SimplesearchTwigExtension());
+ }
+
/**
* Enable search only if url matches to the configuration.
*
@@ -241,8 +270,23 @@ public function onPagesInitialized()
$this->collection->append($extras);
}
- // use a configured sorting order if not already done
- if (!$new_approach) {
+ // Sort by relevance score if we have scored results
+ if (!empty($this->scored_results) && $this->config->get('plugins.simplesearch.relevance_sort', true)) {
+ // Sort scored results by score (descending)
+ uasort($this->scored_results, function($a, $b) {
+ return $b['score'] <=> $a['score'];
+ });
+
+ // Rebuild collection with sorted pages
+ $sorted_collection = new Collection();
+ foreach ($this->scored_results as $path => $data) {
+ if ($this->collection->offsetExists($path)) {
+ $sorted_collection[$path] = ['slug' => $data['page']->slug()];
+ }
+ }
+ $this->collection = $sorted_collection;
+ } elseif (!$new_approach) {
+ // use a configured sorting order if not already done
$this->collection = $this->collection->order(
$this->config->get('plugins.simplesearch.order.by'),
$this->config->get('plugins.simplesearch.order.dir')
@@ -324,58 +368,128 @@ public function checkForPermissions($collection)
}
/**
- * @param string $query
- * @param Page $page
- * @param array|false $taxonomies
- * @return bool
+ * Calculate relevance score for a page based on query matches
+ *
+ * @param string $query Search query
+ * @param Page $page Page to score
+ * @param array|false $taxonomies Taxonomy filters
+ * @return float Relevance score (0 = no match, higher = better match)
*/
- private function notFound($query, $page, $taxonomies)
+ private function calculateRelevanceScore(string $query, Page $page, $taxonomies): float
{
- $searchable_types = $search_content = $this->config->get('plugins.simplesearch.searchable_types');
- $results = true;
+ $score = 0.0;
+ $searchable_types = $this->config->get('plugins.simplesearch.searchable_types');
$search_content = $this->config->get('plugins.simplesearch.search_content');
- $result = null;
+ // Weight factors for different content types
+ $weights = [
+ 'title' => 10.0,
+ 'taxonomy' => 5.0,
+ 'header' => 3.0,
+ 'content' => 1.0
+ ];
+
foreach ($searchable_types as $type => $enabled) {
- if ($type === 'title' && $enabled) {
- $result = $this->matchText(strip_tags($page->title()), $query) === false;
- } elseif ($type === 'taxonomy' && $enabled) {
- if ($taxonomies === false) {
- continue;
- }
+ if (!$enabled) {
+ continue;
+ }
+
+ $text = '';
+ $weight = $weights[$type] ?? 1.0;
+
+ if ($type === 'title') {
+ $text = strip_tags($page->title());
+ } elseif ($type === 'taxonomy' && $taxonomies !== false) {
$page_taxonomies = $page->taxonomy();
- $taxonomy_match = false;
foreach ((array)$page_taxonomies as $taxonomy => $values) {
- // if taxonomies filter set, make sure taxonomy filter is valid
if (!is_array($values) || (is_array($taxonomies) && !empty($taxonomies) && !in_array($taxonomy, $taxonomies))) {
continue;
}
-
- $taxonomy_values = implode('|', $values);
- if ($this->matchText($taxonomy_values, $query) !== false) {
- $taxonomy_match = true;
- break;
- }
- }
- $result = !$taxonomy_match;
- } elseif ($type === 'content' && $enabled) {
- if ($search_content === 'raw') {
- $content = $page->rawMarkdown();
- } else {
- $content = $page->content();
+ $text .= ' ' . implode(' ', $values);
}
- $result = $this->matchText(strip_tags($content), $query) === false;
- } elseif ($type === 'header' && $enabled) {
+ } elseif ($type === 'content') {
+ $text = $search_content === 'raw' ? $page->rawMarkdown() : $page->content();
+ $text = strip_tags($text);
+ } elseif ($type === 'header') {
$header = (array) $page->header();
- $content = $this->getArrayValues($header);
- $result = $this->matchText(strip_tags($content), $query) === false;
+ $text = strip_tags($this->getArrayValues($header));
+ }
+
+ if ($text) {
+ $score += $this->scoreText($text, $query) * $weight;
}
- $results = (bool)$result;
- if ($results === false) {
- break;
+ }
+
+ return $score;
+ }
+
+ /**
+ * Score text relevance for a query
+ *
+ * @param string $text Text to search
+ * @param string $query Search query
+ * @return float Score based on matches and density
+ */
+ private function scoreText(string $text, string $query): float
+ {
+ $score = 0.0;
+ $text_lower = mb_strtolower($text);
+ $query_lower = mb_strtolower($query);
+ $text_length = mb_strlen($text);
+
+ if ($text_length === 0) {
+ return 0.0;
+ }
+
+ // Exact phrase match (highest score)
+ if (mb_stripos($text, $query) !== false) {
+ $score += 100.0;
+ }
+
+ // Word boundary match
+ if (preg_match('/\b' . preg_quote($query_lower, '/') . '\b/ui', $text_lower)) {
+ $score += 50.0;
+ }
+
+ // Count occurrences and calculate density
+ $occurrences = mb_substr_count($text_lower, $query_lower);
+ if ($occurrences > 0) {
+ $score += $occurrences * 10.0;
+ // Density bonus (prefer shorter texts with same number of matches)
+ $density = $occurrences / ($text_length / 100);
+ $score += $density * 5.0;
+ }
+
+ // Starts with query (early occurrence bonus)
+ if (mb_strpos($text_lower, $query_lower) === 0) {
+ $score += 20.0;
+ }
+
+ return $score;
+ }
+
+ /**
+ * Check if page matches query (legacy method for backward compatibility)
+ *
+ * @param string $query Search query
+ * @param Page $page Page to check
+ * @param array|false $taxonomies Taxonomy filters
+ * @return bool True if page does NOT match
+ */
+ private function notFound(string $query, Page $page, $taxonomies): bool
+ {
+ $score = $this->calculateRelevanceScore($query, $page, $taxonomies);
+
+ // Store score for later sorting
+ if ($score > 0) {
+ $path = $page->path();
+ if (!isset($this->scored_results[$path])) {
+ $this->scored_results[$path] = ['page' => $page, 'score' => 0.0];
}
+ $this->scored_results[$path]['score'] += $score;
}
- return $results;
+
+ return $score === 0.0;
}
/**
@@ -411,17 +525,113 @@ public function onTwigSiteVariables()
if ($this->query) {
$twig->twig_vars['query'] = implode(', ', $this->query);
$twig->twig_vars['search_results'] = $this->collection;
+
+ // Pagination support
+ $results_per_page = (int) $this->config->get('plugins.simplesearch.results_per_page', 10);
+ $uri = $this->grav['uri'];
+ $current_page = (int) ($uri->param('page') ?: $uri->query('page') ?: 1);
+
+ if ($results_per_page > 0 && $this->collection) {
+ $total_results = $this->collection->count();
+ $total_pages = (int) ceil($total_results / $results_per_page);
+ $current_page = max(1, min($current_page, $total_pages));
+ $offset = ($current_page - 1) * $results_per_page;
+
+ // Slice collection for current page
+ $paginated_results = new Collection();
+ $items = $this->collection->slice($offset, $results_per_page);
+ foreach ($items as $path => $page) {
+ $paginated_results[$path] = $page;
+ }
+
+ $twig->twig_vars['search_results'] = $paginated_results;
+ $twig->twig_vars['pagination'] = [
+ 'current_page' => $current_page,
+ 'total_pages' => $total_pages,
+ 'total_results' => $total_results,
+ 'results_per_page' => $results_per_page,
+ 'has_prev' => $current_page > 1,
+ 'has_next' => $current_page < $total_pages,
+ ];
+ }
+
+ // Pass scored results for relevance display
+ $twig->twig_vars['scored_results'] = $this->scored_results;
}
+ // Load CSS assets
if ($this->config->get('plugins.simplesearch.built_in_css')) {
- $this->grav['assets']->add('plugin://simplesearch/css/simplesearch.css');
+ if ($this->config->get('plugins.simplesearch.use_modern_assets', true)) {
+ $this->grav['assets']->add('plugin://simplesearch/css/simplesearch.modern.css');
+ } else {
+ $this->grav['assets']->add('plugin://simplesearch/css/simplesearch.css');
+ }
}
+ // Load JavaScript assets
if ($this->config->get('plugins.simplesearch.built_in_js')) {
- $this->grav['assets']->addJs('plugin://simplesearch/js/simplesearch.js', ['group' => 'bottom']);
+ if ($this->config->get('plugins.simplesearch.use_modern_assets', true)) {
+ $this->grav['assets']->addJs('plugin://simplesearch/js/simplesearch.modern.js', ['group' => 'bottom']);
+ } else {
+ $this->grav['assets']->addJs('plugin://simplesearch/js/simplesearch.js', ['group' => 'bottom']);
+ }
}
}
+ /**
+ * Highlight search terms in text
+ *
+ * @param string $text Text to highlight
+ * @param string $query Search query
+ * @param string $class CSS class for highlighting
+ * @return string Text with highlighted terms
+ */
+ public function highlightText(string $text, string $query, string $class = 'search-highlight'): string
+ {
+ if (empty($query) || empty($text)) {
+ return $text;
+ }
+
+ $query_lower = mb_strtolower($query);
+
+ // Protect HTML tags from being split
+ $pattern = '/(' . preg_quote($query, '/') . ')/ui';
+ $replacement = '$1';
+
+ return preg_replace($pattern, $replacement, $text);
+ }
+
+ /**
+ * Extract relevant excerpt from text containing search query
+ *
+ * @param string $text Full text
+ * @param string $query Search query
+ * @param int $length Excerpt length
+ * @return string Excerpt with query context
+ */
+ public function extractExcerpt(string $text, string $query, int $length = 200): string
+ {
+ $text = strip_tags($text);
+ $query_lower = mb_strtolower($query);
+ $text_lower = mb_strtolower($text);
+
+ $pos = mb_strpos($text_lower, $query_lower);
+
+ if ($pos === false) {
+ // Query not found, return beginning
+ return mb_substr($text, 0, $length) . (mb_strlen($text) > $length ? '...' : '');
+ }
+
+ // Center the excerpt around the query
+ $start = max(0, $pos - (int)($length / 2));
+ $excerpt = mb_substr($text, $start, $length);
+
+ $prefix = $start > 0 ? '...' : '';
+ $suffix = ($start + $length) < mb_strlen($text) ? '...' : '';
+
+ return $prefix . $excerpt . $suffix;
+ }
+
/**
* @param array $array
* @param array|null $ignore_keys
diff --git a/simplesearch.yaml b/simplesearch.yaml
index 3a234ce..572228d 100644
--- a/simplesearch.yaml
+++ b/simplesearch.yaml
@@ -1,21 +1,54 @@
enabled: true
built_in_css: true
built_in_js: true
+use_modern_assets: true # Use modern ES6+ JavaScript and enhanced CSS
display_button: false
min_query_length: 3
route: /search
search_content: rendered
template: simplesearch_results
+
+# Search behavior
filters:
category:
filter_combinator: and
ignore_accented_characters: false
+
+# Sorting
order:
by: date
dir: desc
+relevance_sort: true # Sort by relevance score (overrides order settings)
+
+# Pagination
+results_per_page: 10 # Set to 0 to disable pagination
+show_pagination_info: true
+
+# Result display
+show_excerpts: true
+excerpt_length: 200
+show_relevance_score: true
+show_result_count: true
+
+# Advanced search features
+instant_search: false # Enable live search as you type
+autocomplete: false # Enable search suggestions
+keyboard_shortcuts: true # Enable Ctrl+K and / shortcuts
+
+# Searchable content types
searchable_types:
title: true
content: true
taxonomy: true
header: false
-header_keys_ignored: [ 'title', 'taxonomy','content', 'form', 'forms', 'media_order' ]
\ No newline at end of file
+
+# Header search configuration
+header_keys_ignored: [ 'title', 'taxonomy','content', 'form', 'forms', 'media_order' ]
+
+# Performance
+cache_enabled: false
+cache_lifetime: 3600 # Cache duration in seconds
+
+# API endpoints
+enable_json_api: true
+enable_autocomplete_api: false
\ No newline at end of file
diff --git a/templates/partials/simplesearch_item.html.twig b/templates/partials/simplesearch_item.html.twig
index feab4a6..3d97806 100644
--- a/templates/partials/simplesearch_item.html.twig
+++ b/templates/partials/simplesearch_item.html.twig
@@ -4,19 +4,32 @@
{% if banner %}
{% endif %}
{{ page.date|date(config.system.pages.dateformat.short) }}
+ {% if scored_results[page.path()] is defined %}
+
+
+
+ {% endif %}
-
{{ page.summary|raw }}
+ {% if config.plugins.simplesearch.show_excerpts|default(true) %}
+ {% set content_text = page.content %}
+ {% set smart_excerpt = content_text|excerpt(query, config.plugins.simplesearch.excerpt_length|default(200)) %}
+
{{ smart_excerpt|highlight(query)|raw }}
+ {% else %}
+
{{ page.summary|highlight(query)|raw }}
+ {% endif %}
diff --git a/templates/simplesearch_results.html.twig b/templates/simplesearch_results.html.twig
index 539a1d7..b8e94a2 100644
--- a/templates/simplesearch_results.html.twig
+++ b/templates/simplesearch_results.html.twig
@@ -6,18 +6,88 @@
{% include 'partials/simplesearch_searchbox.html.twig' %}
-
+
{% if query %}
- {% set count = search_results ? search_results.count : 0 %}
- {% if count is same as( 1 ) %}
+ {% set count = pagination.total_results|default(search_results ? search_results.count : 0) %}
+ {% if count is same as(1) %}
{{ "PLUGIN_SIMPLESEARCH.SEARCH_RESULTS_SUMMARY_SINGULAR"|t(query|e)|raw }}
{% else %}
{{ "PLUGIN_SIMPLESEARCH.SEARCH_RESULTS_SUMMARY_PLURAL"|t(query|e, count)|raw }}
{% endif %}
+ {% if pagination is defined %}
+
+ {% endif %}
+ {% endif %}
+
+
+ {% if search_results and search_results.count > 0 %}
+
+ {% for page in search_results %}
+ {% include 'partials/simplesearch_item.html.twig' with {'page': page} %}
+ {% endfor %}
+
+
+ {% if pagination is defined and pagination.total_pages > 1 %}
+
{% endif %}
-
- {% for page in search_results %}
- {% include 'partials/simplesearch_item.html.twig' with {'page': page} %}
- {% endfor %}
+ {% elseif query %}
+
+
{{ "No results found for your search."|t }}
+