jbouzekri/sculpin-search-bundle

Provides search in static site via indextank search engine

1.0.1 2014-07-16 21:32 UTC

Requires

• flaptor/indextank-php: @dev

MIT

• php
• search
• bundle
• sculpin
• indextank

README

This bundle provides a search engine using indextank service for your static site.

You can use the service Indexden.

You can see a working demo on the right column of my personal french blog.

Installation

Using composer, add the dependancy to your composer.json :

"require": {
    "jbouzekri/sculpin-search-bundle": "1.*",
    "flaptor/indextank-php": "@dev"
},
"repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/flaptor/indextank-php"
    }
]

And run the composer update command (indextank must be declared in your composer.json because the current stable version does not include the composer file moreover it is not yet on packagist so the repositories part is required)

Enable the bundle. If you have already have an app/SculpinKernel.php, add this bundle to it otherwise create the file with the following content :

<?php

class SculpinKernel extends \Sculpin\Bundle\SculpinBundle\HttpKernel\AbstractKernel
{
    protected function getAdditionalSculpinBundles()
    {
        return array(
            'Jb\Bundle\SearchBundle\JbSearchBundle'
        );
    }
}

Then you need to configure the indextank service in sculpin_kernel.yml :

jb_search:
    options:
        url: http://login.api.indexden.com
        user: "Your login here"
        password: "Your password here"
        index: "The name of your index"

If you use indexden, you can use the private url to fill this parameters : http://:[e-mail]

Usage

On each post you want to index, add the indexed: true data in the markdown part of the file.

---
indexed: true
---

You can now regenerate your site.

You can now add a form HTML markup to your site :

<form id="search-form" action="/search" method="get">
    <div class="input-group" id="search">
        <input type="text" class="form-control" id="search-field" name="q" placeholder="Search" autocomplete="off" />
        <span class="input-group-btn">
            <button class="btn btn-default" type="submit">
                <span class="glyphicon glyphicon-search"></span>
            </button>
        </span>
    </div>
</form>

This bundle provides a simple indextank client library in js you can use. Add the Resources/public/js/indextank_client.js to your project. You can now use the following code to update your list of posts when performing a search :

$('#search-form').indexTank({
    url: "http://login.api.indexden.com",
    index: "index_name",
    display: function(result) {
        if (result.matches == 0) {
            $('.entries').html('<li>No result</li>');
            return;
        }

        var html = "";
        for (id in result.results) {
            var date = new Date(result.results[id].date*1000);
            html += '\
                <li> \
                    <small>' + date.getDate()+'/'+date.getMonth()+'/'+date.getFullYear() + '</small> \
                    <a href="' + result.results[id].link + '">' + result.results[id].title + '</a> \
                </li>';
        }
        $('.entries').html(html);
    }
});

How it works

An event listener is bind to the afterRun event. It indexes in indextank all documents marked with the indexed flag.

When indexing, it clears the index and bulk add the selected sources so it can take some times to generate the site when you index a lot of document.

Because of that, I added a generate command which wrap the original sculpin generate one in order to add an option no-index. When runing this command, you can work on your static site and the content will not be indexed each time you change something in a file. (However do not forget to launch the generate command without this parameter at the end to update your index in the search service).

$ php sculpin generate-search --server  --watch --no-index

Configuration Reference

jb_search:
    enabled: true # enable the indexation at the end of the generate task
    engine: indextank # change the engine (for now only indextank is supported)
    options:
        url: http://login.api.indexden.com
        user: "Your login here"
        password: "Your password here"
        index: "The name of your index"

License

MIT