README

What is this?

RediSearch-PHP is a PHP client library for the RediSearch module which adds Full-Text search to Redis.

See the documentation for more information.

Contributing

Contributions are welcome. Before submitting a PR for review, please run confirm all tests in the test suite pass.

Start the local Docker dev environment by running:

docker compose up

...or simply:

./dev

Then run the tests:

vendor/bin/robo test

Specific Redis clients can be tested:

vendor/bin/robo test:predis
vendor/bin/robo test:php-redis
vendor/bin/robo test:redis-client

Or to run tests for all clients:

vendor/bin/robo test:all

Do not run tests on a prod system (of course), or any system that has a Redis instance with data you care about - Redis is flushed between tests.

To fix code style, before submitting a PR:

vendor/bin/robo task:fix-code-style

Laravel Support

Laravel-RediSearch - Exposes RediSearch-PHP to Laravel as a Scout driver.