silverstripe-fulltextsearch/README.md

FullTextSearch module

Adds support for fulltext search engines like Sphinx and Solr to SilverStripe CMS. Compatible with PHP 7.2

Maintainer Contact

• Hamish Friedlander <hamish (at) silverstripe (dot) com>

Requirements

• SilverStripe 4.0+

Note: For SilverStripe 3.x, please use the 2.x release line.

Documentation

For pure Solr docs, check out the Solr 4.10.4 guide.

See the docs for configuration and setup, or for the quick version see the quick start guide.

For details of updates, bugfixes, and features, please see the changelog.

TODO

• Get rid of includeSubclasses - isn't actually used in practice, makes the codebase uglier, and ClassHierarchy can be 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 $query->search('Text', SiteTree::class . '_Content') like you have to do now

  • 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