2011-05-02 16:33:05 +12:00
# FullTextSearch module
2017-11-15 16:09:37 +13:00
[](https://travis-ci.org/silverstripe/silverstripe-fulltextsearch)
[](https://scrutinizer-ci.com/g/silverstripe/silverstripe-fulltextsearch/?branch=master)
[](https://codecov.io/gh/silverstripe/silverstripe-fulltextsearch)
2018-06-15 17:41:34 +12:00
[](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
2013-03-29 10:10:08 +01:00
2013-02-13 09:48:26 +13:00
Adds support for fulltext search engines like Sphinx and Solr to SilverStripe CMS.
2011-05-02 16:33:05 +12:00
## Maintainer Contact
* Hamish Friedlander < hamish ( at ) silverstripe ( dot ) com >
## Requirements
2017-11-15 16:09:37 +13:00
* SilverStripe 4.0+
2011-05-02 16:33:05 +12:00
2017-11-15 16:09:37 +13:00
**Note:** For SilverStripe 3.x, please use the [2.x release line ](https://github.com/silverstripe/silverstripe-fulltextsearch/tree/2 ).
2011-05-02 16:33:05 +12:00
## Documentation
2018-06-11 17:21:35 +01:00
For pure Solr docs, check out [the Solr 4.10.4 guide ](https://archive.apache.org/dist/lucene/solr/ref-guide/apache-solr-ref-guide-4.10.pdf ).
See [the docs ](/docs/en/00_index.md ) for configuration and setup, or for the quick version see [the quick start guide ](/docs/en/01_getting_started.md#quick-start ).
2011-05-02 16:33:05 +12:00
2015-11-19 16:55:50 +13:00
For details of updates, bugfixes, and features, please see the [changelog ](CHANGELOG.md ).
2011-05-02 16:33:05 +12:00
## TODO
2012-07-19 13:27:53 +12:00
* Get rid of includeSubclasses - isn't actually used in practice, makes the codebase uglier, and ClassHierarchy can be
2011-05-02 16:33:05 +12:00
used at query time for most of the same use cases
* Fix field referencing in queries. Should be able to do `$query->search('Text', 'Content')` , not
2017-11-21 10:51:32 +13:00
`$query->search('Text', SiteTree::class . '_Content')` like you have to do now
2011-05-02 16:33:05 +12:00
- Make sure that when field exists in multiple classes, searching against bare fields searches all of them
- Allow searching against specific instances too
* Make fields restrictable by class in an index - 'SiteTree#Content ' to limit fields to a particular class,
maybe 'Content->Summary' to allow calling a specific method on the field object to get the text
* Allow following user relationships (Children.Foo for example)
* Be clearer about what happens with relationships to stateful objects (e.g. Parent.Foo where Parent is versioned)
* Improvements to SearchUpdater
- Make it work properly when in-between objects (the A in A.B.Foo) update
- Allow user logic to cause triggering reindex of documents when field is user generated
* Add generic APIs for spell correction, file text extraction and snippet generation
