silverstripe-searchable

Adds to the default Silverstripe search by adding a custom results
controller and allowing properly adding custom data objects and custom
fields for searching

Installation

Install this module either by downloading and adding to:

[silverstripe-root]/searchable

Then run: http://yoursiteurl.com/dev/build/

Or alternatively add to your projects composer.json

Usage

To add your object to the search results, you need to make Searchable
aware of it. Do this by adding the following to your _config.php:

Searchable::add("ObjectClass", array("Col1","Col2"), "Friendly Title");

This will then add the object to Searchable's searchable classes.

For example, you can add SiteTree using the following:

Searchable::add("SiteTree", array("Title","MenuTitle","Content","URLSegment"), "Pages");

NOTE Searchable will check an object's canView method before adding it to
the list of results. If this returns true (the Silverstripe default for users not
logged in) then the object will not appear.

If you do not require custom view permissions, then the simplest thing to do is add
the following function to your dataobject:

function canView($member = null)
{
    return true;
}

Extended Dataobjects

At the moment Searchable generates errors if you want to try and search
an object that extends another object using the fields of it's parent.

For example, the below will generate an error:

Searchable::add("Page", array("Title","MenuTitle"), "Pages");

You will have to search SiteTree (as it contains the fields Title and
Menutitle).

Results Dashboard

As Searchable can display results for multiple types of object, the
default interface used to display these objects is the "dashboard".

The dashboard displays a summary of results for each object and
generates a view more link to display more of that type of post (for
example, more products, more forum posts, etc).

You can customise how many items are displayed on the dashboard with the
config variable:

Searchable.dashboard_items

If searchable is only setup for one type of object, the dashboard will be
disabled and instead the user will be taken directly to a search results
page for that object.

Custom search templates

By default the search results are rendered into two templates:

SearchResults.ss

Or

SearchResults_object.ss

The former controls the apperance of the dashboard, the latter
controls the apperance of the results for a particular object.

You can further customise how the results appear on an object specific
bases by adding a template named after the object in question, for
example:

SearchResults_Product.ss

The above would be used to display only search results for a product
object.

Overwrite the default page length

You can change the default page length of search results by using
configuration:

Searchable::config()->page_lenth = 20;

Or, in config.yml

Searchable:
  page_lenth: 20

Custom results controller

It's possible to change the default controller used by searchabe to
display results. You can do this by changing the template class
configuration variable:

Searchable::config()->template_class = 'your_custom_controller';

Or, in config.yml

Searchable:
  template_class: 'your_custom_controller'