Download the PHP package jbouzekri/sculpin-search-bundle without Composer

On this page you can find all versions of the php package jbouzekri/sculpin-search-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package sculpin-search-bundle

SculpinSearchBundle

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 :

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 :

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

If you use indexden, you can use the private url to fill this parameters : http://:[email protected]

Usage

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

You can now regenerate your site.

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

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 :

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

Configuration Reference

License

MIT


All versions of sculpin-search-bundle with dependencies

PHP Build Version
Package Version
Requires flaptor/indextank-php Version @dev
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jbouzekri/sculpin-search-bundle contains the following files

Loading the files please wait ....