PHPackages                             arnoson/kirby-loupe - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. arnoson/kirby-loupe

ActiveKirby-plugin[Database & ORM](/categories/database)

arnoson/kirby-loupe
===================

Search Kirby with Loupe

0.4.1(2mo ago)38812↓50%2[2 issues](https://github.com/arnoson/kirby-loupe/issues)MITPHPPHP ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0

Since May 4Pushed 5mo ago3 watchersCompare

[ Source](https://github.com/arnoson/kirby-loupe)[ Packagist](https://packagist.org/packages/arnoson/kirby-loupe)[ Docs](https://github.com/arnoson/kirby-loupe)[ RSS](/packages/arnoson-kirby-loupe/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (13)Used By (0)

   ![](./.github/logo-light.svg)

Kirby Loupe
===========

[](#kirby-loupe)

A thin wrapper around [Loupe](https://github.com/loupe-php/loupe/), an SQLite based, PHP-only fulltext search engine.

Key Features
------------

[](#key-features)

- 🎯 Typo tolerant / fuzzy search
- 🔍 Filtering and sorting
- 📄 Built-in pagination
- 🌍 Works everywhere, no SQLite extensions needed
- ⚡ Decent performance (~100ms for 5000 documents, ~300ms on low-end shared hosting)

Install
-------

[](#install)

```
composer require arnoson/kirby-loupe
```

Usage
-----

[](#usage)

You have to index your existing content once. After the initial indexing the index will be updated automatically via Kirby's page hooks.

```
// Call this once or use the panel field (see #reindex)
arnoson\KirbyLoupe::reindex();
```

```
// Inside your template/controller.

$results = KirbyLoupe::search(
  // See https://github.com/loupe-php/loupe/blob/main/docs/searching.md#query
  query: "...",

  //  See https://github.com/loupe-php/loupe/blob/main/docs/searching.md#filter
  filter: "interests = 'music'",

  // See https://github.com/loupe-php/loupe/blob/main/docs/searching.md#sort
  sort: ["title:asc"],

  // Loupe always paginates the results, default is 20.
  paginate: 100
);

foreach ($results as $result) {
  echo $result->title();
}
```

Options
-------

[](#options)

```
'arnoson.kirby-loupe' => [
    // Which pages to include in the search.
    'pages' => fn($page) => $page->intendedTemplate()->name() === 'item',

    // Which fields to include in the search.
    'fields' => [
        // Can be just the field name ...
        'title',
        // or a callback, transforming the field for better searching.
        'text' => fn($page) => strip_tags($page->text()),
        // loupe also supports so called multi fields (arrays) allowing you to
        // do advanced filtering.
        'interests' => fn($page) => $page->interests()->split(),
    ],

    // Which fields to include in the text search, default is all fields.
    'searchable' => ['title', 'text'],

    // Which fields to include in the filtering.
    'filterable' => ['interests'],

    // Which fields to include in the sorting.
    'sortable' => ['title'],

    // Additional loupe configuration, see: https://github.com/loupe-php/loupe/blob/main/docs/configuration.md
    'configuration' => fn() => Loupe\Loupe\Configuration::create()
      ->withLanguages(['en', 'fr', 'de']),
]
```

Reindex
-------

[](#reindex)

This plugin will automatically update Loupe's search index via page hooks. But for your initial content, or after you have manually uploaded content, you will need to index your site explicitly. To do so either call

```
KirbyLoupe::reindex();
```

Or use the panel field

```
fields:
  reindex:
    type: loupe-reindex
```

As indexing large numbers of pages (thousands) can potentially break due to maximum execution time, especially on shared hosting, indexing via the Panel is done in chunks. The default is `100`, so 100 pages will be indexed at a time and a progress bar will be displayed. If you only have a small number of pages, or a good enough server, you can disable chunks and index all pages at once.

```
fields:
  reindex:
    type: loupe-reindex
    chunk: false # disable chunks
    chunk: 500 # or increase chunk size
```

Pagination
----------

[](#pagination)

The result has a pagination attached, so you can build your navigation, see the `/example/site/templates/default` for a full example.

```