ethanhann/redisearch-php

2.1.0 2023-09-09 22:38 UTC

Requires

• php: >=8.2
• ethanhann/redis-raw: ^2.1.0
• psr/log: ^3.0.0

Requires (Dev)

• cheprasov/php-redis-client: ^1.9
• consolidation/robo: ^4.0.0-alpha1
• friendsofphp/php-cs-fixer: ^v3.10.0
• mockery/mockery: ^1.5.0
• monolog/monolog: ^3.2.0
• phpunit/phpunit: ^9.5.23
• predis/predis: ^v2.0.0
• ukko/phpredis-phpdoc: ^5.0@beta

MIT

• Ethan Hann

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.