Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/g4b0/silverstripe-searchable-dataobjects

Searchable DataObjects is a module that permit to include DataObjects into frontend search
https://github.com/g4b0/silverstripe-searchable-dataobjects

Last synced: 2 months ago
JSON representation

Searchable DataObjects is a module that permit to include DataObjects into frontend search

Lists

README 

        
# Searchable DataObjects



Searchable DataObjects is a module that permit to include DataObjects into frontend search.



## Introduction



Pages are not always the better way to implement things. For example site news can grow rapidly and the first side effect

would be a big and difficult to manage SiteTree. DataObjects help maintaining things clean and straight, but unfortunately

they are not included in frontend search. This module let you insert DataObject in search.



## Requirements



 * SilverStripe 4.1

 * g4b0/htmlpurifier



For SilverStripe 3.1 usage please referr to version 3.0 and below.

For SilverStripe >3.1 & <4.0 usage please referr to version 4.x.



### Installation



Install the module through [composer](http://getcomposer.org):



    composer require g4b0/searchable-dataobjects

    composer update



Make the DataObject (or Pages) implement Searchable interface (you need to implement Link(), getSearchFilter(), getTitleFields(),

getContentFields()):



*Note: `getSearchFilterByCallback()` is an optional filter. If you don't plan on calculating any value to determine a returned `true` or `false` value it is suggested you don't add this function to your `DataObject` or `Page` type.*



```php

use g4b0\SearchableDataObjects\Searchable;



class DoNews extends DataObject implements Searchable {



    private static $db = array(

        'Title' => 'Varchar',

        'Subtitle' => 'Varchar',

        'News' => 'HTMLText',

        'Date' => 'Date',

    );

    private static $has_one = array(

        'Page' => 'PghNews'

    );



    /**

     * Link to this DO

     * @return string

     */

    public function Link() {

        return $this->Page()->Link() . 'read/' . $this->ID;

    }



    /**

     * Filter array

     * eg. array('Disabled' => 0);

     * @return array

     */

    public static function getSearchFilter() {

        return array();

    }



    /**

     * FilterAny array (optional)

     * eg. array('Disabled' => 0, 'Override' => 1);

     * @return array

     */

    public static function getSearchFilterAny() {

        return array();

    }



    /**

     * FilterByCallback function (optional)

     * eg. function($object){

     *  return ($object->StartDate > date('Y-m-d') || $object->isStillRecurring());

     * };

     * @return array

     */

    public static function getSearchFilterByCallback() {

        return function($object){ return true; };

    }



    /**

     * 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');

    }

}

```



Here you are a sample page holder, needed to implement the Link() function into the DataObject:



```php

class PghNews extends Page {



    private static $has_many = array(

        'News' => 'DoNews'

    );



    public function getCMSFields() {

        $fields = parent::getCMSFields();



        /* News */

        $gridFieldConfig = GridFieldConfig_RelationEditor::create(100);

        // Remove unlink

        $gridFieldConfig->removeComponentsByType('GridFieldDeleteAction');

        // Add delete

        $gridFieldConfig->addComponents(new GridFieldDeleteAction());

        // Remove autocompleter

        $gridFieldConfig->removeComponentsByType('GridFieldAddExistingAutocompleter');

        $field = new GridField('Faq', 'Faq', $this->News(), $gridFieldConfig);

        $fields->addFieldToTab('Root.News', $field);



        return $fields;

    }

}



class PghNews_Controller extends Page_Controller {



    private static $allowed_actions = array(

        'read'

    );



    public function read(SS_HTTPRequest $request) {

        $arguments = $request->allParams();

        $id = $arguments['ID'];



        // Identifico la faq dall'ID

        $Object = DataObject::get_by_id('DoNews', $id);



        if ($Object) {

            //Popolo l'array con il DataObject da visualizzare

            $Data = array($Object->class => $Object);

            $this->data()->Title = $Object->Title;



            $retVal = $this->Customise($Data);

            return $retVal;

        } else {

            //Not found

            return $this->httpError(404, 'Not found');

        }

    }

}

```



Extend Page and the desired DataObjects through the following yaml:



```YAML

Page:

  extensions:

    - g4b0\SearchableDataObjects\SearchableDataObject

DoNews:

  extensions:

    - g4b0\SearchableDataObjects\SearchableDataObject

```



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



    sake dev/build "flush=all"

    sake dev/tasks/PopulateSearch



Enjoy the news into the search results :)



### Modifying



#### Set the number of search results per page



Setting the `g4b0\SearchableDataObjects\CustomSearch.items_per_page` config setting you can define, how many search results per page are shown. Default is 10



By default the search result is shown at the same page, so if you're searching e.g. on the */about-us/*, the results are

shown on */about-us/SearchForm/?s=foo*. If you don't like that, you can define any Page or Controller class in the

`g4b0\SearchableDataObjects\CustomSearch.search_controller` setting. If you set this setting to `this`, the current page will be used. Defaults to `SearchPage`

and falls back to the current page if no SearchPage is found.



```YAML

g4b0\SearchableDataObjects\CustomSearch:

  items_per_page: 15

  search_controller: g4b0\SearchableDataObjects\SearchPage #page type to show the search

```



### 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.



### TODO



 * Add other search method in configuration



### Suggested modules



 * Linkable DataObjects: http://addons.silverstripe.org/add-ons/g4b0/linkable-dataobjects