dnadesign / silverstripe-googlesitesearch
Add Google Site Search to your SilverStripe Site.
Installs: 6 167
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 14
Forks: 10
Open Issues: 1
Type:silverstripe-vendormodule
Requires
- silverstripe/framework: >=3.1
This package is not auto-updated.
Last update: 2024-10-31 12:21:57 UTC
README
Requirements
- SilverStripe 4
Documentation
Adds the ability for a user to search the site through Google Site Search. This is done via a new Page in the CMS (GoogleSiteSearchPage) and results are fetched from Google via ajax. The search form and results are free to style via CSS.
-
Sign up for www.google.com/sitesearch
-
Install this module to your site root folder named
googlesitesearch
-
Rebuild your database using
dev/build
-
Enter your Google CSE CX and key values in the CMS under a new instance of the newly added GoogleSiteSearchPage or through the config flag
GoogleSiteSearchPage.cse_key
andGoogleSiteSearchPage.cse_cx
respectively. -
Add the default search form to your controller (or use your own extension for styling / changing the form). In mysite/_config/googlesitesearch.yml add the following:
Controller: extensions:
- GoogleSiteSearchDefaultFormExtension
-
Add a search form to your
Page.ss
template $GoogleSiteSearchForm
Ensure you read the Google Custom Search Terms before installing the module and agree to the terms and conditions https://www.google.co.nz/cse/docs/tos.html
Customization
Full HTML control is available by providing a custom GoogleSiteSearchPage
template on the page. Since the results are loaded via AJAX, John Resig's Micro Templating
is used to provide basic utility templates in results, header and footer
templates.
Out of the box a basic header message and pagination in the footer is provided but you are free to alter the page as you need to. More documentation on the available data to output to the template (such as file information) is at developers.google.com/custom-search/v1/using_rest