2017 © Pedro Peláez
 

silverstripe-vendormodule silverstripe-extensible-search

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

image

nglasl/silverstripe-extensible-search

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

  • Wednesday, February 28, 2018
  • by nglasl
  • Repository
  • 4 Watchers
  • 12 Stars
  • 14,875 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 8 Forks
  • 3 Open issues
  • 47 Versions
  • 7 % Grown

The README.md

extensible search

The current release is 4.1.4, (*1)

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions., (*2)

Requirement

  • SilverStripe 3.1 → 4.0

This repository is no longer supported, however this module is still supported here., (*3)

Getting Started

Overview

Extensible Search Page

This is automatically created, and allows configuration for search based on a search engine (more below)., (*4)

page, (*5)

Search Engine

The extensible search page is designed to use full-text search out of the box, while providing support for custom search engine implementations (elastic search for example)., (*6)

Full-Text

SilverStripe\ORM\Search\FulltextSearchable:
  searchable_classes:
    - 'SilverStripe\CMS\Model\SiteTree'
SilverStripe\CMS\Model\SiteTree:
  create_table_options:
    MySQLDatabase: 'ENGINE=MyISAM'
  extensions:
    - "SilverStripe\\ORM\\Search\\FulltextSearchable('Title', 'MenuTitle', 'Content', 'MetaDescription')"

When considering the search engine to use, full-text has some important limitations. This configuration can also be applied to File, however, unfortunately it does not support further customisation., (*7)

Custom Search Engine

The following is an example configuration, where ElasticSearch extends the abstract CustomSearchEngine class:, (*8)

nglasl\extensible\ExtensibleSearchPage:
  custom_search_engines:
    nglasl\extensible\ElasticSearch: 'Elastic'

Search Form

PageController:
  extensions:
    - 'nglasl\extensible\ExtensibleSearchExtension'

Using this, to display the search form that users interact with (from your template):, (*9)

$SearchForm

Search Analytics

These are important to help determine either popular content on your site, or whether content is difficult for users to locate. They're automatically enabled out of the box, however, can be disabled using the following:, (*10)

nglasl\extensible\ExtensibleSearch:
  enable_analytics: false

analytics, (*11)

When triggering a search, appending ?analytics=false to the URL will bypass the search analytics. This is fantastic for debugging., (*12)

Archiving

Depending on your search traffic, /dev/tasks/ExtensibleSearchArchiveTask may be used to archive past search analytics, for each search page. It would be recommended to trigger this on a schedule where possible., (*13)

archives, (*14)

archive, (*15)

Search Suggestions

These are most effective alongside the search analytics (in which case they're automatically populated), and can be used to display either popular searches on your site, or search form autocomplete options. They're automatically enabled out of the box, however, can be disabled using the following:, (*16)

nglasl\extensible\ExtensibleSearchSuggestion:
  enable_suggestions: false

suggestions, (*17)

To enable autocomplete using the approved search suggestions.., (*18)

Requirements::javascript('nglasl/silverstripe-extensible-search: client/javascript/extensible-search-suggestions.js');

// OPTIONAL.

Requirements::css('jquery-ui.min.css');
Requirements::javascript('jquery-ui.min.js');

Smart Templating

Custom search engine specific templates may be defined for your search results. These are just two examples:, (*19)

ElasticSearch_results.ss or Page_results.ss, (*20)

SS4 Changes

  • The custom search engine implementation has changed, and no longer uses extensions (see above).

Maintainer Contact

Nathan Glasl, nathan@symbiote.com.au

The Versions

28/02 2018

dev-master

9999999-dev https://github.com/nglasl/silverstripe-extensible-search

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

28/02 2018

4.1.0

4.1.0.0 https://github.com/nglasl/silverstripe-extensible-search

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

06/12 2017

4.0.0

4.0.0.0 https://github.com/nglasl/silverstripe-extensible-search

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

06/12 2017

4.0.x-dev

4.0.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

30/11 2017

3.1.x-dev

3.1.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

30/11 2017

3.1.12

3.1.12.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

13/10 2017

3.1.11

3.1.11.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

25/09 2017

3.1.10

3.1.10.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

01/08 2017

3.1.9

3.1.9.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

23/05 2017

3.1.8

3.1.8.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

16/03 2017

3.1.7

3.1.7.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

17/02 2017

3.1.6

3.1.6.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

17/02 2017

3.1.5

3.1.5.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

16/02 2017

3.1.4

3.1.4.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

30/01 2017

3.1.3

3.1.3.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

19/01 2017

3.1.2

3.1.2.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

05/01 2017

3.1.1

3.1.1.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

11/12 2016

3.1.0

3.1.0.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

07/12 2016

3.0.x-dev

3.0.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

07/12 2016

3.0.4

3.0.4.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

21/11 2016

3.0.3

3.0.3.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

03/08 2016

3.0.2

3.0.2.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

03/08 2016

2.1.x-dev

2.1.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

03/08 2016

2.1.4

2.1.4.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

03/08 2016

2.0.x-dev

2.0.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

03/08 2016

2.0.3

2.0.3.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

01/08 2016

3.0.1

3.0.1.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

25/07 2016

3.0.0

3.0.0.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

11/07 2016

2.1.3

2.1.3.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

20/06 2016

2.1.2

2.1.2.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

16/03 2016

2.1.1

2.1.1.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

15/03 2016

2.1.0

2.1.0.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

27/01 2016

2.0.2

2.0.2.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

27/01 2016

2.0.1

2.0.1.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

18/01 2016

2.0.0

2.0.0.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

04/09 2015

1.1.x-dev

1.1.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

04/09 2015

1.1.8

1.1.8.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

09/07 2015

1.1.7

1.1.7.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

29/05 2015

1.0.x-dev

1.0.9999999.9999999-dev https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance.

  Sources   Download

BSD-3-Clause

The Requires

 

search engine silverstripe

26/05 2015

1.1.6

1.1.6.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

20/05 2015

1.1.5

1.1.5.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

01/05 2015

1.1.4

1.1.4.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance, including analytics and suggestions.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

12/01 2015

1.1.3

1.1.3.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

10/12 2014

1.1.2

1.1.2.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

05/12 2014

1.1.1

1.1.1.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

28/11 2014

1.1.0

1.1.0.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance.

  Sources   Download

BSD-3-Clause

The Requires

 

search full-text silverstripe

20/08 2014

1.0.0

1.0.0.0 https://github.com/nglasl/silverstripe-extensible-search

A module for SilverStripe which will allow user customisation and developer extension of a search page instance.

  Sources   Download

BSD-3-Clause

The Requires

 

search engine silverstripe