taq/torm-elastic

ElasticSearch integration for TORM

TORM-elasticsearch

This is a trait to insert ElasticSearch funcionality on TORM objects., _(*1)

Installation

Change (or create, if needed) your Composer file to include it:, _(*2)

{
    "require": {
        "taq/torm-elastic": ">=0"
    }
}

Usage

Just open your model and insert the trait, like:, _(*3)

class User extends TORM\Model {
    use TORM\ElasticSearch;
}
User::setElasticSearchIndex("myapp");

and, after every object saving, it will be send for ElasticSearch indexing, using some rules:, _(*4)

• Need to insert the trait using use TORM\ElasticSearch on the model;
• Need to specify the app name using setElasticSearchIndex(). This will be the ElasticSearch index.
• After inserting the trait, a new afterInitialize method will be added on the model. If the model already has a afterInitialize method, the TORM\ElasticSearch afterInitialize method must be called explicity on its end. This is because of the way PHP traits works.
• If not specified, all the model attributes will be indexed. To define just some key attributes, we can use the setElasticSearchValues(<attributes>) method, sending an array with the attributes, like: User::setElasticSearchValues(["name"]); then only the name attribute will be indexed.

Searching

Then we can search using something like:, _(*5)

$rtn = ElasticUser::elasticSearch("name", "john");
var_dump($rtn);

resulting in something like, _(*6)

array(2) {
  'id' =>
  string(1) "1"
  'name' =>
  string(12) "John Doe Jr."
}

Importing

When importing a new data collection, we can use the import method, like:, _(*7)

User::elasticImport();

Getting document count

User:;elasticCount();

Updating a document

We can explicity update a document using:, _(*8)

$obj->updateElasticSearch();

Deleting a document

We can explicity delete a document using:, _(*9)

$obj->deleteElasticSearch();

Disabling

We can disable updating documents using, _(*10)

TORM\ElasticSearchConfigs::disabled(true);

and enable again sending false on the same method., _(*11)

Testing

If using a TORM test enviroment (defined setting the enviroment var TORM_ENV to test), the index name will be automatically changed to <index_name>_test., _(*12)

If we want to avoid updating a document on the test enviroment, we can use, _(*13)

TORM\ElasticSearchConfigs::avoidOnTests(true);