Giter Club home page Giter Club logo

silverstripe-searchable-dataobjects's Introduction

Firebrand Searchable DataObjects

Firebrand Searchable DataObjects is a fork of Zirak's Searchable DataObjects.

Firebrand's version will return Pages matching a search criteria or having related Data Objects matching the search criteria. Zirak's version returns the DataObjects individual data objects.

Introduction

Complexe SilverStripe pages will sometimes need to be divided up in various parts using DataObjects. Out of the box SilverStripe will only index the content in the main WYSIWYG area of a page. This means that related DataObjects will not be indexed and that their parent pages will not be returned in search results.

Requirements

  • SilverStripe 3.1
  • zirak/htmlpurifier

Installation

Install the module through composer:

composer require firebrandhq/searchable-dataobjects

Make the DataObject (or Pages) implement Searchable or SearchableLinkable interface. You need to define getSearchFilter(), getTitleFields(), getContentFields(), getOwner(), IncludeInSearch()). Classes that implement the SearchableLinkable interface, must additionnaly define a Link() function.

DataObjects that are accessible via a URL should implement SearchableLinkable while DataObjects that belong to a parent object without being reable directly URL accessible should implement Searchable.

class DoNews extends DataObject implements SearchableLinkable {

	private static $db = array(
		'Title' => 'Varchar',
		'Subtitle' => 'Varchar',
		'News' => 'HTMLText',
		'Date' => 'Date',
	);
	private static $has_one = array(
		'Page' => 'PghNews'
	);
	
	private static $has_many = array(
		'Asides' => 'Aside'
	);

	/**
	 * Filter array
	 * eg. array('Disabled' => 0);
	 * @return array
	 */
	public static function getSearchFilter() {
		return array();
	}

	/**
	 * Fields that compose the Title
	 * eg. array('Title', 'Subtitle');
	 * @return array
	 */
	public function getTitleFields() {
		return array('Title');
	}

	/**
	 * Fields that compose the Content
	 * eg. array('Teaser', 'Content');
	 * @return array
	 */
	public function getContentFields() {
		return array('Subtitle', 'Content');
	}
	
	/**
	 * Parent objects that should be displayed in search results.
	 * @return SiteTree or SearchableLinkable
	 */
	public function getOwner() {
		return $this;
	}
	
	/**
	 * Whatever this specific Searchable should be included in search results.
	 * This allows you to exclude some DataObjects from search results.
	 * It plays more or less the same role that ShowInSearch plays for SiteTree.
	 * @return boolean
	 */
	public function IncludeInSearch() {
		return true;
	}
	
	/**
	 * Link to access this DO
	 * @return string
	 */
	public function Link() {
		$this->Page->Link('news/' . $this->ID);
	}
}
class Aside extends DataObject implements Searchable {

	private static $db = array(
		'Header' => 'Varchar',
		'Content' => 'HTMLText',
	);
	private static $has_one = array(
		'DoNews' => 'DoNews'
	);


	/**
	 * Filter array
	 * eg. array('Disabled' => 0);
	 * @return array
	 */
	public static function getSearchFilter() {
		return array();
	}

	/**
	 * Fields that compose the Title
	 * eg. array('Title', 'Subtitle');
	 * @return array
	 */
	public function getTitleFields() {
		return array('Header');
	}

	/**
	 * Fields that compose the Content
	 * eg. array('Teaser', 'Content');
	 * @return array
	 */
	public function getContentFields() {
		return array('Content');
	}
	
	/**
	 * Parent objects that should be displayed in search results.
	 * @return SiteTree or SearchableLinkable
	 */
	public function getOwner() {
		return $this->DoNews;
	}
	
	/**
	 * Whatever this specific Searchable should be included in search results.
	 * This allows you to exclude some DataObjects from search results.
	 * It plays more or less the same role that ShowInSearch plays for SiteTree.
	 * @return boolean
	 */
	public function IncludeInSearch() {
		return true;
	}
}

Extend Page and the desired DataObjects through the following yaml:

Page:
	extensions:
		- SearchableDataObject
DoNews:
	extensions:
		- SearchableDataObject

Run a dev/build and then populate the search table running PopulateSearch task:

sake dev/build "flush=all"
sake dev/tasks/PopulateSearch

When you save your pages or you DataObject, they will automatically update their entry in the search table.

Note

Searchable DataObjects module use Mysql NATURAL LANGUAGE MODE search method, so during your tests be sure not to have all DataObjetcs with the same content, since words that are present in 50% or more of the rows are considered common and do not match.

From MySQL manual entry [http://dev.mysql.com/doc/refman/5.1/en/fulltext-search.html]:

A natural language search interprets the search string as a phrase in natural human language (a phrase in free text). There are no special operators. The stopword list applies. In addition, words that are present in 50% or more of the rows are considered common and do not match. Full-text searches are natural language searches if the IN NATURAL LANGUAGE MODE modifier is given or if no modifier is given.

silverstripe-searchable-dataobjects's People

Contributors

antons- avatar g4b0 avatar marc-firebrand avatar maxime-rainville avatar ntsim avatar oliverjonesfb avatar wernerkrauss avatar yusuf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

silverstripe-searchable-dataobjects's Issues

dataobject not showing in resultspage

i'm trying to implement this on a project i'm working on. I followed the steps, but the dataobject (Organisatie) is not showing up in the result. The table is populated though (see screenshot). Am i missing something? Another thing i noticed is that it doesn't use partialmatch. If i search for "silver", the page with content "silverstripe" is not in the search results. I hope someone can help me out soon! Thanx!
searchable

Translatable Compatabilty

The module doesn't seem compatable with Translatable, the manual seach query doesn't pass the Locale field. Unfortunatly I'm not fluent enough in SQL queries to make the change.

Something missing?

Has anyone gotten this to work? I dont get any dataObjects to show on search. Everything returns a result of 0. and the search results page now reads "RISULTATI DELLA RICERCA" what could i be missing? I added the instructed methods and ran a build and Searchable task. Any help would be very much appreciated. Thanks!

No automatically update on save or publish

Hi and thank you.

I installed the add-on and it works great the only thing it doesn’t do is automatically update their entry in the search table.

My dataobject is versioned with heyday/silverstripe-versioneddataobjects V 1.4.0 is there any way I can make this work?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.