PHPackages                             werkbot/werkbot-search - 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. [Search & Filtering](/categories/search)
4. /
5. werkbot/werkbot-search

ActiveSilverstripe-vendormodule[Search & Filtering](/categories/search)

werkbot/werkbot-search
======================

Provides search functionality with TNTSearch

3.1.3(yesterday)02.1k1[1 PRs](https://github.com/werkbot/silverstripe-module-search/pulls)MITPHPPHP ^8.0 || ^8.1

Since Apr 1Pushed 2w ago2 watchersCompare

[ Source](https://github.com/werkbot/silverstripe-module-search)[ Packagist](https://packagist.org/packages/werkbot/werkbot-search)[ Docs](https://github.com/werkbot/silverstripe-module-search)[ RSS](/packages/werkbot-werkbot-search/feed)WikiDiscussions main Synced yesterday

READMEChangelog (10)Dependencies (10)Versions (33)Used By (0)

Silverstripe TNTSearch
======================

[](#silverstripe-tntsearch)

[![Latest Stable Version](https://camo.githubusercontent.com/ea9a6bcf0e1cc6f0b11c6888eeb66a19f6ef51202b1eb9a13cca3912d5aecd36/687474703a2f2f706f7365722e707567782e6f72672f7765726b626f742f7765726b626f742d7365617263682f76)](https://packagist.org/packages/werkbot/werkbot-search) [![Total Downloads](https://camo.githubusercontent.com/33644d7eaad14147d4124e1a14feebc7c63b6f148280623776cd11fef7e3070d/687474703a2f2f706f7365722e707567782e6f72672f7765726b626f742f7765726b626f742d7365617263682f646f776e6c6f616473)](https://packagist.org/packages/werkbot/werkbot-search) [![Latest Unstable Version](https://camo.githubusercontent.com/719f80549ee672f85743c1c60fc01e2d999b774c7987354b0a0f62dbaf99ee16/687474703a2f2f706f7365722e707567782e6f72672f7765726b626f742f7765726b626f742d7365617263682f762f756e737461626c65)](https://packagist.org/packages/werkbot/werkbot-search) [![License](https://camo.githubusercontent.com/e1eaeca19cf38085e9ca5d5ed1392ed87b0c96145f3ebb7938b667de40cf755a/687474703a2f2f706f7365722e707567782e6f72672f7765726b626f742f7765726b626f742d7365617263682f6c6963656e7365)](https://packagist.org/packages/werkbot/werkbot-search) [![PHP Version Require](https://camo.githubusercontent.com/5a8ca39ef4274140ecc772cab4e858b2d46461cde1b71ce86b984c3f1b03138a/687474703a2f2f706f7365722e707567782e6f72672f7765726b626f742f7765726b626f742d7365617263682f726571756972652f706870)](https://packagist.org/packages/werkbot/werkbot-search)

A silverstripe search module that utilizes TNTSearch to index content.

Installation
------------

[](#installation)

```
composer require werkbot/werkbot-search

```

#### Requirements

[](#requirements)

-

Setup
-----

[](#setup)

Add the following extensions to Page

```
Page::add_extension(SearchableExtension::class);
PageController::add_extension(SearchControllerExtension::class);
```

You will need to run `dev/build`

### Define getIndexQuery on Page

[](#define-getindexquery-on-page)

The `Page::class` will need to have a function `getIndexQuery` defined. Here is an example for Page:

```
/**
 * getIndexQuery
 * This query is used when building the index
 *
 * @return string|boolean - FALSE if not set
 */
public function getIndexQuery()
{
  $class = get_class($this);
  $class = str_replace('\\', '\\\\', $class);

  /*
    Alternatively, just use the short class name of the current file
    Example: "Page"
  */
  $indexQueryDeclaringClassShortname = $this->owner->getIndexQueryDeclaringClassShortname();

  return