https://github.com/ethanhann/redisearch-php

PHP client library for RediSearch.
https://github.com/ethanhann/redisearch-php

php php7 redis redis-search redisearch redisearch-php search searching

Last synced: about 2 months ago
JSON representation

PHP client library for RediSearch.

• Host: GitHub
• URL: https://github.com/ethanhann/redisearch-php
• Owner: ethanhann
• License: mit
• Created: 2017-03-15T23:43:03.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-03-16T22:39:42.000Z (6 months ago)
• Last Synced: 2024-07-19T04:57:33.190Z (2 months ago)
• Topics: php, php7, redis, redis-search, redisearch, redisearch-php, search, searching
• Language: PHP
• Homepage: http://www.ethanhann.com/redisearch-php/
• Size: 1.58 MB
• Stars: 221
• Watchers: 14
• Forks: 57
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# RediSearch PHP Client

[![Latest Stable Version](https://poser.pugx.org/ethanhann/redisearch-php/v/stable)](https://packagist.org/packages/ethanhann/redisearch-php)

[![Total Downloads](https://poser.pugx.org/ethanhann/redisearch-php/downloads)](https://packagist.org/packages/ethanhann/redisearch-php)

[![Latest Unstable Version](https://poser.pugx.org/ethanhann/redisearch-php/v/unstable)](https://packagist.org/packages/ethanhann/redisearch-php)

[![License](https://poser.pugx.org/ethanhann/redisearch-php/license)](https://packagist.org/packages/ethanhann/redisearch-php)

**What is this?**

RediSearch-PHP is a PHP client library for the [RediSearch](http://redisearch.io/) module which adds Full-Text search to Redis.

See the [documentation](http://www.ethanhann.com/redisearch-php/) 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:

```shell

docker compose up

```

...or simply:

```shell

./dev

```

Then run the tests:

```shell

vendor/bin/robo test

```

Specific Redis clients can be tested:

```shell

vendor/bin/robo test:predis

vendor/bin/robo test:php-redis

vendor/bin/robo test:redis-client

```

Or to run tests for all clients:

```shell

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:

```shell

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

```

**Laravel Support**

[Laravel-RediSearch](https://github.com/ethanhann/Laravel-RediSearch) - Exposes RediSearch-PHP to Laravel as a Scout driver.