Elastica is a PHP client for elasticsearch
PHP Shell
Pull request Compare This branch is 2545 commits behind ruflin:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Elastica: elasticsearch PHP Client Build Status

PHP client for the distributed search engine elasticsearch which is based on Lucene and can be an alternative to solr. The client naming and structure is consistent with Zend Framework and other PHP frameworks. This makes it easy to use the client in combination with Zend Framework.

With this client I try to model the elasticsearch REST API in an object oriented way which also makes it possible to extend the client and add new types of queries, filters, facets, transport layers and more. The client uses the REST API from elasticsearch and tries to provide a simple way of accessing the elasticsearch functionality. Arguments are passed as arrays which are automatically encoded to JSON which makes it possible to also use not implemented features of the request methods.

Support / Bug Reports

For all support questions please use the Elastica google group.

For bug reports and issues please use the issue tracker from github.


For changes in the API please check the file changes.txt


The version numbers are consistent with elasticsearch. The version number means it is the first release for elasticsearch version 0.16.0. The next release is called As soon as the elasticsearch is updated and the client is updated, also the next version is called Like this it should be always clear to which versions the Elastica client is compatible.


Several Elastica examples can be found on my blog in the Elastica Category

Lots of basic examples can also be found in the test classes.

// Creates a new index 'xodoa' and a type 'user' inside this index
$client = new Elastica_Client();    
$index = $client->getIndex('xodoa');
$index->create(array(), true);

$type = $index->getType('user');

// Adds 1 document to the index
$doc1 = new Elastica_Document(1, 
	array('username' => 'hans', 'test' => array('2', '3', '5'))

// Adds a list of documents with _bulk upload to the index
$docs = array();
$docs[] = new Elastica_Document(2, 
	array('username' => 'nicolas', 'test' => array('1', '3', '6'))
$docs[] = new Elastica_Document(3, 
	array('username' => 'ruflin', 'test' => array('2', '3', '7'))

// Index needs a moment to be updated

$resultSet = $type->search('ruflin');

The basic object structure is as following: Client -> Index -> Type -> Document


At the moment the client should be backward compatible to PHP 5.2. That's the reason why the client was not directly built with namespaces and other nice PHP 5.3 features.

File indexing

File upload is supported but the mapper attachement plugin has to be installed

./bin/plugin install mapper-attachments

Building API

The API is build automatically from the source code by DocBlox (How to install it: http://docs.docblox-project.org/Installation.html)

To create an updated API just run the following in the root in the master branch:

docblox run

Then move the created folder 'build/api' to the gh-pages branch and push.


To all users that gave feedback and committed code https://github.com/ruflin/Elastica/network/members.